{ "schemes": [], "swagger": "2.0", "info": { "description": "* ***[GraphQL Playground](/graph)*** - make more powerful queries with GraphQL.\n\n
Error codes\n\n| Code | Text | Description |\n|----|---------------------------------|------------------------------------------------------------------------------------------|\n| 1 | Authenticate failed | Thrown when the JWT is faulty, expired or the session key is wrong or expired. |\n| 2 | Parameter validation failed | Thrown when a query or path parameter fails validated. |\n| 3 | Permission denied | Thrown when the user does not have proper permissions setup in the back office. |\n| 4 | Internal error | Thrown when there is an internal server error. |\n| 5 | Database connection failed | Thrown because of an internal error or if another region user accesses the API. |\n| 6 | Database level error | Thrown when a record is not found, or there was an error reading/writing to the database. |\n| 7 | Decoding json request failed | Thrown when a faulty JSON request is provided. |\n| 8 | Account configuration error | Thrown when the account's back office configuration blocks an operation on the API. |\n| 9 | Api configuration error | Thrown when the API is mis-configured internally. |\n| 10 | JSON field validation error | Thrown when a json request field fails validation. |\n| 11 | Database field validation error | Thrown when a database field failed validation before appearing in the API response. |\n
\n\n
Auth with Cookies\n\nAdd `apisession_` cookie with your session key + `clientCode` HTTP header\n
\n\n**FAQ** \n\nQ: Is there a possibility to save a contact person to a business customer?\n\nA: If the use-case is to define a contact person for a business customer, you should create an individual customer and set the **employerId** to the business customer ID. This will indicate that this person is a contact person / an employee in a particular company.\n", "title": "CRM API", "contact": { "email": "david.zingerman@erply.com" }, "version": "1.32.8" }, "host": "", "basePath": "", "paths": { "/v1/addresses": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Addresses" ], "summary": "Get addresses", "parameters": [ { "type": "string", "description": "match type of the filtering. Supported values: `=`, `\u003e=`, `\u003c=`, `contains`, `startswith`. Default is `=`", "name": "match", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "address Ids", "name": "ids", "in": "query" }, { "type": "integer", "description": "Retrieve only items that have been added or modified at/after/before a specified timestamp. Use it to keep a local database in sync with Erply.", "name": "changed", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "customer Id", "name": "customerIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "address type Id", "name": "typeIds", "in": "query" }, { "type": "string", "description": "street", "name": "street", "in": "query" }, { "type": "string", "description": "address2", "name": "address2", "in": "query" }, { "type": "string", "description": "post Code", "name": "postCode", "in": "query" }, { "type": "string", "description": "city", "name": "city", "in": "query" }, { "type": "string", "description": "country", "name": "country", "in": "query" }, { "type": "string", "description": "state", "name": "state", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.CustomerAddressResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } }, "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Create an address", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Addresses" ], "summary": "Create an address", "parameters": [ { "description": "addressRequest", "name": "addressRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.CreateAddressRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/addresses/types": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Retrieve address types", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Address Types" ], "summary": "Get address types", "parameters": [ { "type": "string", "description": "match type of the filtering. Supported values: `=`, `\u003e=`, `\u003c=`, `contains`, `startswith`. Default is `=`", "name": "match", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "address type Ids", "name": "ids", "in": "query" }, { "type": "integer", "description": "Retrieve only items that have been added or modified at/after/before a specified timestamp. Use it to keep a local database in sync with Erply.", "name": "changed", "in": "query" }, { "type": "boolean", "description": "Indicates whether this is a type of actively used addresses, or a type of archived/old addresses. Address which has a type where isActivelyUsed=false cannot be used as a customer's shipping address on invoice.", "name": "isActivelyUsed", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.AddressTypeResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/addresses/{ids}": { "delete": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Addresses" ], "summary": "Delete addresses", "parameters": [ { "type": "string", "description": "up to 100 semicolon separated address Ids", "name": "ids", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.BulkResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/addresses/{id}": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Input only the fields you want to update", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Addresses" ], "summary": "Update an address", "parameters": [ { "type": "integer", "description": "address Id", "name": "id", "in": "path", "required": true }, { "description": "addressRequest", "name": "addressRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.UpdateAddressRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/attributes": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "API client specifies record Id or multiple Ids and fetches attributes for all those records.\nFiltering \u0026 Sorting by Value is not supported.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Attributes" ], "summary": "Read Attributes", "parameters": [ { "type": "string", "description": "match type of the filtering. Supported values: `=`, `\u003e=`, `\u003c=`, `contains`, `startswith`. Default is `=`", "name": "match", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "records are the objects that have the attributes. The parameter can contain up to 100 semicolon delimited ids.", "name": "recordIds", "in": "query" }, { "type": "string", "description": "attribute entity name, The possible entities are: customer, customer group", "name": "entityName", "in": "query", "required": true }, { "type": "string", "description": "attribute name", "name": "name", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "amount to take", "name": "take", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.AttributeResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } }, "put": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "To Create an attribute you must leave the id field empty. To Update you must specify the ID field. RecordID refers to the object that the attribute will be attached to.\nSupported entities: 'customer', 'customer group', 'address'.\nName cannot have spaces and is limited to 50 characters. One database record must not have multiple attributes with the same name.\n3 `types` are available - int, double, text. Based on the type the `value` should be number of text.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Attributes" ], "summary": "Attach / Update an Attribute", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.AttributeRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/attributes/{ids}": { "delete": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Attributes" ], "summary": "Delete attributes", "parameters": [ { "type": "string", "description": "up to 100 semicolon delimited IDs", "name": "ids", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.BulkResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/business/areas": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Retrieve the areas of business, customers have their areas of business as a separate entity.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Business Areas" ], "summary": "Get areas of business", "parameters": [ { "type": "string", "description": "match type of the filtering. Supported values: `=`, `\u003e=`, `\u003c=`, `contains`, `startswith`. Default is `=`", "name": "match", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "area of business ids", "name": "ids", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.BusinessAreaResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } }, "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Create an area of business", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Business Areas" ], "summary": "Create an area of business", "parameters": [ { "description": "businessAreaRequest", "name": "businessAreaRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.BusinessAreaRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/business/areas/{ids}": { "delete": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Business Areas" ], "summary": "Delete areas of business", "parameters": [ { "type": "string", "description": "up to 100 semicolon delimited area of business ids", "name": "ids", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.BulkResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/business/areas/{id}": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Business Areas" ], "summary": "Update an area of business", "parameters": [ { "type": "integer", "description": "area of business id", "name": "id", "in": "path", "required": true }, { "description": "businessAreaRequest", "name": "businessAreaRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.BusinessAreaRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "The fields are not the same as in get individual / get business customers.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Customers" ], "summary": "Get all customers", "parameters": [ { "type": "string", "description": "match type of the filtering. Supported values: `=`, `\u003e=`, `\u003c=`, `contains`, `startswith`. Default is `=`", "name": "match", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the customer ids", "name": "ids", "in": "query" }, { "enum": [ "PERSON", "COMPANY" ], "type": "string", "description": "Search by the customer type. Possible values are 'PERSON', 'COMPANY'", "name": "customerType", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the business type ids", "name": "businessTypeIds", "in": "query" }, { "type": "integer", "description": "Retrieve only items that have been added or modified at/after/before a specified timestamp. Use it to keep a local database in sync with Erply.", "name": "changed", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the customer group ids", "name": "customerGroupIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the business area ids", "name": "businessAreaIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the Person's job title ids", "name": "jobTitleIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": " Search by the employer ids. (Persons only.) Business where this individual is an employee / a contact person", "name": "employerIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the customer manager ids", "name": "customerManagerIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the title ids. A title (Mr / Mrs / Miss) etc.", "name": "titleIds", "in": "query" }, { "type": "string", "description": "Search by the e-invoice email address", "name": "eInvoiceEmail", "in": "query" }, { "type": "boolean", "description": "whether the customer wants to receive invoices via electronic channels.", "name": "eInvoicesViaEmailEnabled", "in": "query" }, { "type": "string", "description": "Search by the e-invoice reference number.", "name": "eInvoiceReference", "in": "query" }, { "type": "boolean", "description": "whether the customer wants to receive invoices via email.", "name": "invoicesViaEmailEnabled", "in": "query" }, { "type": "boolean", "description": "whether the customer wants to receive invoices via docura.", "name": "invoicesViaDocuraEnabled", "in": "query" }, { "type": "boolean", "description": "whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).", "name": "paperMailsEnabled", "in": "query" }, { "type": "string", "description": "Search by the operator id. E-invoice integration parameter.", "name": "operatorId", "in": "query" }, { "type": "string", "description": "Search by the edi codeE-invoice integration parameter.", "name": "ediCode", "in": "query" }, { "enum": [ "2DOC", "4DOC", "SPECIAL" ], "type": "string", "description": "Search by the edi type. E-invoice integration parameter.", "name": "ediType", "in": "query" }, { "type": "string", "description": "Search by the last name / family name. For individuals only.", "name": "lastName", "in": "query" }, { "type": "string", "description": "Search by the first name / given name. For individuals only.", "name": "firstName", "in": "query" }, { "type": "string", "description": "Search by the business name, For businesses only.", "name": "businessName", "in": "query" }, { "type": "string", "description": "Search by the company name. For businesses only.", "name": "name", "in": "query" }, { "type": "string", "description": "Search by the Full name of the customer", "name": "fullName", "in": "query" }, { "type": "string", "description": "Search by the national Id", "name": "code", "in": "query" }, { "type": "string", "description": "Search by the person's birthday", "name": "birthDate", "in": "query" }, { "type": "string", "description": "Search by the VAT number", "name": "vatNumber", "in": "query" }, { "type": "string", "description": "Search by the name of the bank", "name": "bankName", "in": "query" }, { "type": "string", "description": "Search by the customer's bank account number", "name": "bankAccountNumber", "in": "query" }, { "type": "string", "description": "Search by the BIC/SWIFT identifier of customer's bank account", "name": "bankSwiftCode", "in": "query" }, { "type": "string", "description": "Search by the IBAN number of customer's bank account", "name": "bankIban", "in": "query" }, { "type": "string", "description": "Search by phone", "name": "phone", "in": "query" }, { "type": "string", "description": "Search by mobile", "name": "mobile", "in": "query" }, { "type": "string", "description": "Search by fax", "name": "fax", "in": "query" }, { "type": "string", "description": "Search by mail", "name": "mail", "in": "query" }, { "type": "string", "description": "Search by skype", "name": "skype", "in": "query" }, { "type": "string", "description": "Search by website", "name": "website", "in": "query" }, { "type": "string", "description": "Search by notes", "name": "notes", "in": "query" }, { "type": "string", "description": "Search by the web-shop username. This is for web shop integrations: to store customers' web-shop login credentials in Erply", "name": "webShopUsername", "in": "query" }, { "type": "boolean", "description": "Search by the flag “Sales for cash only”. By default,false", "name": "salesForCashOnly", "in": "query" }, { "type": "integer", "description": "Search by the customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe", "name": "creditLimit", "in": "query" }, { "type": "integer", "description": "Search by the default payment deadline (in days)", "name": "defaultPaymentDeadLine", "in": "query" }, { "type": "number", "format": "float64", "description": "Search by the late fee / penalty for overdue invoices", "name": "penaltyForOverdue", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the payer ids, payer of invoices is another customer", "name": "payerIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the customer’s country", "name": "countryIds", "in": "query" }, { "type": "string", "description": "Search by the customer’s reference number for sales invoices", "name": "referenceNumber", "in": "query" }, { "type": "string", "description": "Search by the integration code. Corresponding customer identifier in a system integrated with Erply (e.g. accounting software)", "name": "integrationCode", "in": "query" }, { "type": "string", "description": "Search by the loyalty card number. The code of customer's loyalty/membership card. This code must match the sequence produced by card swipe", "name": "loyaltyCardNumber", "in": "query" }, { "type": "string", "description": "Search by the factoring contract number", "name": "factoringContractNumber", "in": "query" }, { "enum": [ "DOMESTIC", "EU", "OUTSIDE_EU", "EU_WITH_VAT" ], "type": "string", "description": "Customer type. Possible values are ", "name": "type", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the assigned price list", "name": "priceListIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the second assigned price list", "name": "priceListIds2", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the third assigned price list", "name": "priceListIds3", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the fourth assigned price list", "name": "priceListIds4", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the fifth assigned price list", "name": "priceListIds5", "in": "query" }, { "type": "boolean", "description": "Search by the flag “taxExempt”.", "name": "taxExempt", "in": "query" }, { "type": "boolean", "description": "Search by the flag “Partial tax exemption”.", "name": "partialTaxExemption", "in": "query" }, { "type": "boolean", "description": "Search by the flag “Do not sell”.", "name": "doNotSell", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by tagIds. Get all customers with at least one of those tags", "name": "tagIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the tax office ids. Feature used by Greek customers: office where the customer / supplier reports to.", "name": "taxOfficeIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by custom homestore IDs. Used only by specific accounts.", "name": "homeStoreCustomIds", "in": "query" }, { "type": "integer", "description": "Search by signUpStoreId", "name": "signUpStoreId", "in": "query" }, { "type": "string", "description": "Search by color. Color that the customer entry is marked with. Possible values: ", "name": "color", "in": "query" }, { "type": "integer", "description": "Search by added date.", "name": "added", "in": "query" }, { "type": "integer", "description": "Search by added from.", "name": "addedFrom", "in": "query" }, { "type": "integer", "description": "Search by added to.", "name": "addedTo", "in": "query" }, { "type": "integer", "description": "Search by changedByEmployeeId.", "name": "changedByEmployeeId", "in": "query" }, { "type": "boolean", "description": "Mark if a customer should be starred", "name": "isStarred", "in": "query" }, { "type": "string", "description": "Search by the postal code of the customer's address. Note that this option uses additional source to search the result, which makes it slower.", "name": "addressPostalCode", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.CustomerResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/businesses": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Business Customers" ], "summary": "Get business customers", "parameters": [ { "type": "string", "description": "match type of the filtering. Supported values: `=`, `\u003e=`, `\u003c=`, `contains`, `startswith`. Default is `=`", "name": "match", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by customer Ids", "name": "ids", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by customer type ids", "name": "typeIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by customer group ids", "name": "customerGroupIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the business area ids", "name": "businessAreaIds", "in": "query" }, { "type": "integer", "description": "Retrieve only items that have been added or modified at/after/before a specified timestamp. Use it to keep a local database in sync with Erply.", "name": "changed", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by customer manager ids", "name": "customerManagerIds", "in": "query" }, { "type": "string", "description": "Search by the e-invoice email address", "name": "eInvoiceEmail", "in": "query" }, { "type": "boolean", "description": "whether the customer wants to receive invoices via electronic channels.", "name": "eInvoicesViaEmailEnabled", "in": "query" }, { "type": "string", "description": "Search by the e-invoice reference number.", "name": "eInvoiceReference", "in": "query" }, { "type": "boolean", "description": "whether the customer wants to receive invoices via email.", "name": "invoicesViaEmailEnabled", "in": "query" }, { "type": "boolean", "description": "whether the customer wants to receive invoices via docura.", "name": "invoicesViaDocuraEnabled", "in": "query" }, { "type": "boolean", "description": "whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).", "name": "paperMailsEnabled", "in": "query" }, { "type": "string", "description": "Search by the operator id. E-invoice integration parameter.", "name": "operatorId", "in": "query" }, { "type": "string", "description": "Search by the edi code. E-invoice integration parameter.", "name": "ediCode", "in": "query" }, { "enum": [ "2DOC", "4DOC", "SPECIAL" ], "type": "string", "description": "Search by the edi type. E-invoice integration parameter.", "name": "ediType", "in": "query" }, { "type": "string", "description": "Search by the company name.", "name": "name", "in": "query" }, { "type": "string", "description": "Search by the displayed name. Name with customer type", "name": "displayedName", "in": "query" }, { "type": "string", "description": "Search by the full name. Displayed name 2", "name": "fullName", "in": "query" }, { "type": "string", "description": "Search by the national id", "name": "code", "in": "query" }, { "type": "string", "description": "Search by the VAT number", "name": "vatNumber", "in": "query" }, { "type": "string", "description": "Search by the name of the bank", "name": "bankName", "in": "query" }, { "type": "string", "description": "Search by the customer's bank account number", "name": "bankAccountNumber", "in": "query" }, { "type": "string", "description": "Search by the BIC/SWIFT identifier of customer's bank account.", "name": "bankSwiftCode", "in": "query" }, { "type": "string", "description": "Search by the IBAN number of customer's bank account.", "name": "bankIban", "in": "query" }, { "type": "string", "description": "Search by phone", "name": "phone", "in": "query" }, { "type": "string", "description": "Search by mobile", "name": "mobile", "in": "query" }, { "type": "string", "description": "Search by fax", "name": "fax", "in": "query" }, { "type": "string", "description": "Search by mail", "name": "mail", "in": "query" }, { "type": "string", "description": "Search by skype", "name": "skype", "in": "query" }, { "type": "string", "description": "Search by website", "name": "website", "in": "query" }, { "type": "string", "description": "Search by notes", "name": "notes", "in": "query" }, { "type": "string", "description": "Search by the web-shop username. This is for web shop integrations: to store customers' web-shop login credentials in Erply.", "name": "webShopUsername", "in": "query" }, { "type": "boolean", "description": "Search by the flag “Sales for cash only”. By default,false", "name": "salesForCashOnly", "in": "query" }, { "type": "integer", "description": "Search by the customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe.", "name": "creditLimit", "in": "query" }, { "type": "integer", "description": "Search by the default payment deadline (in days).", "name": "defaultPaymentDeadLine", "in": "query" }, { "type": "number", "format": "float64", "description": "Search by the late fee / penalty for overdue invoices.", "name": "penaltyForOverdue", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by payer ids. Payer of invoices is another customer.", "name": "payerIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the customer’s country ids.", "name": "countryIds", "in": "query" }, { "type": "string", "description": "Search by customer’s reference number for sales invoices.", "name": "referenceNumber", "in": "query" }, { "type": "string", "description": "Search by the integration code. A corresponding customer identifier in a system integrated with Erply (e.g. accounting software)", "name": "integrationCode", "in": "query" }, { "type": "string", "description": "Search by the code of customer's loyalty/membership card. This code must match the sequence produced by card swipe.", "name": "loyaltyCardNumber", "in": "query" }, { "type": "string", "description": "Search by the factoring contract number.", "name": "factoringContractNumber", "in": "query" }, { "enum": [ "DOMESTIC", "EU", "OUTSIDE_EU", "EU_WITH_VAT" ], "type": "string", "description": "Search by the customer type. Possible values are ", "name": "type", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the assigned price list", "name": "priceListIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the second assigned price list", "name": "priceListIds2", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the third assigned price list", "name": "priceListIds3", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the fourth assigned price list", "name": "priceListIds4", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the fifth assigned price list", "name": "priceListIds5", "in": "query" }, { "type": "boolean", "description": "Search by the flag “Partial tax exemption”.", "name": "partialTaxExemption", "in": "query" }, { "type": "boolean", "description": "Search by the flag “Do not sell”.", "name": "doNotSell", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the tax office ids. Feature used by Greek customers: office where the customer / supplier reports to.", "name": "taxOfficeIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by custom homestore IDs. Used only by specific accounts.", "name": "homeStoreCustomIds", "in": "query" }, { "type": "string", "description": "Search by color. Color that the customer entry is marked with. Possible values: ”, 'yellow', 'red', 'blue', 'green'.", "name": "color", "in": "query" }, { "type": "boolean", "description": "Mark if customers should be starred", "name": "isStarred", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.BusinessCustomerResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } }, "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "In order to create a business customer you must have fetched the customer type from get customers/types\nand select a customer group from GET customers/groups", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Business Customers" ], "summary": "Create a business customer", "parameters": [ { "description": "Customer", "name": "customer", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.CreateCompanyRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/businesses/bulk": { "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Each request body is an business customer to create\nThe body can contain up to 100 requests. The response contains the IDs of the results as well as the IDs of the resources updated. resourceID = customerID.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Business Customers" ], "summary": "Create business customers in bulk", "parameters": [ { "description": "Requests", "name": "requests", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_services_customers_bulk.CreateCompanyRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/customers-api_internal_services_customers_bulk.ResponseWithResults" } } } }, "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Each request body is an business customer to update\nThe body can contain up to 100 requests. preserveOldCardNumber flag is the part of the request body. The response contains the IDs of the results as well as the IDs of the resources updated. resourceID = customerID.\nEach request in the request body must contain a resourceID, the preserveOldCardNumber and the fields that are required to update.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Business Customers" ], "summary": "Update business customers in bulk", "parameters": [ { "description": "Requests", "name": "requests", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_services_customers_bulk.UpdateCompanyRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/customers-api_internal_services_customers_bulk.ResponseWithResults" } } } } }, "/v1/customers/businesses/{ids}": { "delete": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Business Customers" ], "summary": "Delete business customers", "parameters": [ { "type": "string", "description": "up to 100 semicolon separated customer Ids", "name": "ids", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.BulkResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/businesses/{id}": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "input only the fields you need to update.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Business Customers" ], "summary": "Update a business customer", "parameters": [ { "type": "integer", "description": "customer Id", "name": "id", "in": "path", "required": true }, { "type": "boolean", "description": "if the flag is present, then the previous card number value gets saved as an old card number", "name": "preserveOldCardNumber", "in": "query" }, { "description": "customer", "name": "customer", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.UpdateCompanyRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/businesses/{id}/turn-into-individual": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "First name and last name are required.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Business Customers" ], "summary": "Turn a business customer into an individual customer", "parameters": [ { "type": "integer", "description": "customer Id", "name": "id", "in": "path", "required": true }, { "type": "boolean", "description": "if the flag is present, then the previous card number value gets saved as an old card number", "name": "preserveOldCardNumber", "in": "query" }, { "description": "customer", "name": "customer", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.UpdateIndividualRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/external-ids": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "External Ids are the ones from different commerce systems. This endpoint enables the API user to read the external Ids of the Erply customers.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Customer External Ids" ], "summary": "Read external Ids of the customers", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "up to 100 external Ids. Cannot be provided with the customerIds parameter", "name": "externalIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "up to 100 customer Ids. Cannot be provided with the externalIds parameter", "name": "customerIds", "in": "query" }, { "type": "string", "description": "integration name", "name": "integrationName", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ExternalIDResponse" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/external-ids/{customerIds}": { "delete": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Requesting the endpoint will delete all the external Ids of needed customers. With the integrationName parameter you can delete only integration-specific external Ids.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Customer External Ids" ], "summary": "Delete external Ids of customers", "parameters": [ { "type": "string", "description": "Specify the integration name to delete the external Id associated with the integration only.", "name": "integrationName", "in": "query" }, { "type": "string", "description": "up to 100 semicolon delimited customer Ids", "name": "customerIds", "in": "path", "required": true } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.BulkResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/external-ids/{customerId}": { "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "External Ids are the ones from different commerce systems. This endpoint enables the API user to attach the external Ids to the Erply customers.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Customer External Ids" ], "summary": "Attach external customer ID to a customer", "parameters": [ { "description": "external ID with the integration name", "name": "externalIdWithIntegrationName", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.ExternalIDRequest" } }, { "type": "integer", "description": "customer Id", "name": "customerId", "in": "path", "required": true } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.EmptyResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } }, "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "External Ids are the ones from different commerce systems that have to be stored in Erply\nThis call allows to update the external Id using the integration name and customer Id.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Customer External Ids" ], "summary": "Update external Id of a customer", "parameters": [ { "description": "external Id with the integration name", "name": "externalIdWithIntegrationName", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.ExternalIDRequest" } }, { "type": "integer", "description": "customer Id", "name": "customerId", "in": "path", "required": true } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/full-text-lookup": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Full text search is a more advanced way to search customers", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Customers" ], "summary": "Lookup customers", "parameters": [ { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" }, { "type": "string", "description": "text to lookup, must be at least 3 characters in length, if quotes are applied a string match is returned", "name": "lookupPhrase", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.CustomerResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/groups": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Customer Groups" ], "summary": "Get customer groups", "parameters": [ { "type": "string", "description": "match type of the filtering. Supported values: `=`, `\u003e=`, `\u003c=`, `contains`, `startswith`. Default is `=`", "name": "match", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "group Ids", "name": "ids", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "parent group ids", "name": "parentIds", "in": "query" }, { "type": "integer", "description": "group's order", "name": "order", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "price list ids", "name": "priceListIds", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.CustomerGroupResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } }, "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Create a customer group", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Customer Groups" ], "summary": "Create a customer group", "parameters": [ { "description": "groupRequest", "name": "groupRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.CreateCustomerGroupRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/groups/indented": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "The result is a indented list of group ids and names sorted by orders and prefixed by the dash (―) sign if is a parent", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Customer Groups" ], "summary": "Get Indented List of Groups", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_services_shared_indentation.Result" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/groups/{ids}": { "delete": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Customer Groups" ], "summary": "Delete customer groups", "parameters": [ { "type": "string", "description": "up to 100 semicolon delimited group Ids", "name": "ids", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.BulkResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/groups/{id}": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Customer Groups" ], "summary": "Update a customer group", "parameters": [ { "type": "integer", "description": "Group Id", "name": "id", "in": "path", "required": true }, { "description": "groupRequest", "name": "groupRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.UpdateCustomerGroupRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/groups/{id}/customers": { "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Add customers to a group, max 100 at a time", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Customer Groups" ], "summary": "Add customers to a group", "parameters": [ { "type": "integer", "description": "group Id", "name": "id", "in": "path", "required": true }, { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.AddCustomersToGroupRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/groups/{id}/move": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "position has to be one of the following: `lastChild` | `before` | `after`", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Customer Groups" ], "summary": "Move a customer group", "parameters": [ { "type": "integer", "description": "group Id", "name": "id", "in": "path", "required": true }, { "description": "moveRequest", "name": "moveRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.MoveRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/individuals": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Individual Customers" ], "summary": "Get individual customers", "parameters": [ { "type": "string", "description": "match type of the filtering. Supported values: `=`, `\u003e=`, `\u003c=`, `contains`, `startswith`. Default is `=`", "name": "match", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the customer ids", "name": "ids", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the customer group ids", "name": "customerGroupIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the business area ids", "name": "businessAreaIds", "in": "query" }, { "type": "integer", "description": "Retrieve only items that have been added or modified at/after/before a specified timestamp. Use it to keep a local database in sync with Erply.", "name": "changed", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the individual's job title ids", "name": "jobTitleIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the employer ids", "name": "employerIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the customer manager ids", "name": "customerManagerIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the title ids. A title (Mr / Mrs / Miss) etc.", "name": "titleIds", "in": "query" }, { "type": "string", "description": "Search by the e-invoice email address", "name": "eInvoiceEmail", "in": "query" }, { "type": "boolean", "description": "whether the customer wants to receive invoices via electronic channels.", "name": "eInvoicesViaEmailEnabled", "in": "query" }, { "type": "string", "description": "Search by the e-invoice reference number.", "name": "eInvoiceReference", "in": "query" }, { "type": "boolean", "description": "whether the customer wants to receive invoices via email.", "name": "invoicesViaEmailEnabled", "in": "query" }, { "type": "boolean", "description": "whether the customer wants to receive invoices via docura.", "name": "invoicesViaDocuraEnabled", "in": "query" }, { "type": "boolean", "description": "whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).", "name": "paperMailsEnabled", "in": "query" }, { "type": "string", "description": "Search by the operator id. E-invoice integration parameter.", "name": "operatorId", "in": "query" }, { "type": "string", "description": "Search by the edi code. E-invoice integration parameter.", "name": "ediCode", "in": "query" }, { "enum": [ "2DOC", "4DOC", "SPECIAL" ], "type": "string", "description": "Search by the edi type. E-invoice integration parameter.", "name": "ediType", "in": "query" }, { "type": "string", "description": "Search by the last name / family name.", "name": "lastName", "in": "query" }, { "type": "string", "description": "Search by the first name / given name.", "name": "firstName", "in": "query" }, { "type": "string", "description": "Search by the displayed name. Name with customer type", "name": "displayedName", "in": "query" }, { "type": "string", "description": "Search by the full name. First name and Last name", "name": "fullName", "in": "query" }, { "type": "string", "description": "Search by the national id", "name": "code", "in": "query" }, { "type": "string", "description": "Search by the date of birth (yyyy-mm-dd)", "name": "birthDate", "in": "query" }, { "type": "string", "description": "Search by the VAT number", "name": "vatNumber", "in": "query" }, { "type": "string", "description": "Search by the name of the bank", "name": "bankName", "in": "query" }, { "type": "string", "description": "Search by the customer's bank account number", "name": "bankAccountNumber", "in": "query" }, { "type": "string", "description": "Search by the BIC/SWIFT identifier of customer's bank account", "name": "bankSwiftCode", "in": "query" }, { "type": "string", "description": "Search by the IBAN number of customer's bank account", "name": "bankIban", "in": "query" }, { "type": "string", "description": "Search by phone", "name": "phone", "in": "query" }, { "type": "string", "description": "Search by mobile", "name": "mobile", "in": "query" }, { "type": "string", "description": "Search by fax", "name": "fax", "in": "query" }, { "type": "string", "description": "Search by mail", "name": "mail", "in": "query" }, { "type": "string", "description": "Search by skype", "name": "skype", "in": "query" }, { "type": "string", "description": "Search by website", "name": "website", "in": "query" }, { "type": "string", "description": "Search by notes", "name": "notes", "in": "query" }, { "type": "string", "description": "Search by the web-shop username. This is for web shop integrations: to store customers' web-shop login credentials in Erply", "name": "webShopUsername", "in": "query" }, { "type": "boolean", "description": "Flag “Sales for cash only”. By default,false", "name": "salesForCashOnly", "in": "query" }, { "type": "integer", "description": "Search by the customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe", "name": "creditLimit", "in": "query" }, { "type": "integer", "description": "Search by the default payment deadline (in days)", "name": "defaultPaymentDeadLine", "in": "query" }, { "type": "number", "format": "float64", "description": "Search by the late fee / penalty for overdue invoices", "name": "penaltyForOverdue", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the payer ids. Payer of invoices is another customer", "name": "payerIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the customer’s country.", "name": "countryIds", "in": "query" }, { "type": "string", "description": "Search by the customer’s reference number for sales invoices.", "name": "referenceNumber", "in": "query" }, { "type": "string", "description": "Search by the integration code. Corresponding customer identifier in a system integrated with Erply (e.g. accounting software)", "name": "integrationCode", "in": "query" }, { "type": "string", "description": "Search by the code of customer's loyalty/membership card. This code must match the sequence produced by card swipe.", "name": "loyaltyCardNumber", "in": "query" }, { "type": "string", "description": "Search by the factoring contract number.", "name": "factoringContractNumber", "in": "query" }, { "enum": [ "DOMESTIC", "EU", "OUTSIDE_EU", "EU_WITH_VAT" ], "type": "string", "description": "Search by the customer type. Possible values are ", "name": "type", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the assigned price list", "name": "priceListIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the second assigned price list", "name": "priceListIds2", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the third assigned price list", "name": "priceListIds3", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the fourth assigned price list", "name": "priceListIds4", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the fifth assigned price list", "name": "priceListIds5", "in": "query" }, { "type": "boolean", "description": "Search by the flag “Partial tax exemption”.", "name": "partialTaxExemption", "in": "query" }, { "type": "boolean", "description": "Search by the flag “Do not sell”.", "name": "doNotSell", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by the tax office ids. Feature used by Greek customers: office where the customer / supplier reports to.", "name": "taxOfficeIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "Search by custom homestore IDs. Used only by specific accounts.", "name": "homeStoreCustomIds", "in": "query" }, { "type": "string", "description": "Search by color. Color that the customer entry is marked with. Possible values: ", "name": "color", "in": "query" }, { "type": "boolean", "description": "Mark if the customers should be starred", "name": "isStarred", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.IndividualCustomerResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } }, "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Individual Customers" ], "summary": "Create an individual customer", "parameters": [ { "description": "Customer", "name": "customer", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.CreateIndividualRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/individuals/bulk": { "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Each request body is an individual customer to create\nThe body can contain up to 100 requests. The response contains the IDs of the results as well as the IDs of the resources updated. resourceID = customerID.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Individual Customers" ], "summary": "Create individual customers in bulk", "parameters": [ { "description": "Requests", "name": "requests", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_services_customers_bulk.CreateIndividualRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/customers-api_internal_services_customers_bulk.ResponseWithResults" } } } }, "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Each request body is an individual customer to update\nThe body can contain up to 100 requests. preserveOldCardNumber flag is the part of the request body. The response contains the IDs of the results as well as the IDs of the resources updated. resourceID = customerID.\nEach request in the request body must contain a resourceID, the preserveOldCardNumber and the fields that are required to update.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Individual Customers" ], "summary": "Update individual customers in bulk", "parameters": [ { "description": "Requests", "name": "requests", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_services_customers_bulk.UpdateIndividualRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/customers-api_internal_services_customers_bulk.ResponseWithResults" } } } } }, "/v1/customers/individuals/job-titles": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Get a list of job titles. Job titles are used to specify employee's job area.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Job Titles" ], "summary": "Get job titles", "parameters": [ { "type": "string", "description": "match type of the filtering. Supported values: `=`, `\u003e=`, `\u003c=`, `contains`, `startswith`. Default is `=`", "name": "match", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "title Ids", "name": "ids", "in": "query" }, { "type": "integer", "description": "title's order", "name": "order", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.JobTitleResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } }, "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Create a job title", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Job Titles" ], "summary": "Create a job title", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.JobTitleRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/individuals/job-titles/{ids}": { "delete": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Job Titles" ], "summary": "Delete job titles", "parameters": [ { "type": "string", "description": "up to 100 semicolon delimited job title ids", "name": "ids", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.BulkResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/individuals/job-titles/{id}": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Job Titles" ], "summary": "Update a job title", "parameters": [ { "type": "integer", "description": "job title id", "name": "id", "in": "path", "required": true }, { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.JobTitleRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/individuals/job-titles/{id}/move": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "position has to be one of the following: `before` | `after`", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Job Titles" ], "summary": "Move a job title", "parameters": [ { "type": "integer", "description": "id", "name": "id", "in": "path", "required": true }, { "description": "moveRequest", "name": "moveRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.MoveRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/individuals/titles": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Retrieve the titles, individuals have their titles as a separate entity.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Titles" ], "summary": "Get individuals titles", "parameters": [ { "type": "string", "description": "match type of the filtering. Supported values: `=`, `\u003e=`, `\u003c=`, `contains`, `startswith`. Default is `=`", "name": "match", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "title Ids", "name": "ids", "in": "query" }, { "type": "integer", "description": "title's order", "name": "order", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.TitleResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } }, "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Create an individual's title", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Titles" ], "summary": "Create an individual's title", "parameters": [ { "description": "titleRequest", "name": "titleRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.TitleRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/individuals/titles/{ids}": { "delete": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Titles" ], "summary": "Delete individual titles", "parameters": [ { "type": "string", "description": "up to 100 semicolon delimited title Ids", "name": "ids", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.BulkResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/individuals/titles/{id}": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Titles" ], "summary": "Update an individual's title", "parameters": [ { "type": "integer", "description": "Title Id", "name": "id", "in": "path", "required": true }, { "description": "titleRequest", "name": "titleRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.TitleRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/individuals/titles/{id}/move": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "position has to be one of the following: `before` | `after`", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Titles" ], "summary": "Move an individual's title", "parameters": [ { "type": "integer", "description": "id", "name": "id", "in": "path", "required": true }, { "description": "moveRequest", "name": "moveRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.MoveRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/individuals/{ids}": { "delete": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Individual Customers" ], "summary": "Delete individual customers", "parameters": [ { "type": "string", "description": "up to 100 semicolon delimited customer Ids", "name": "ids", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.BulkResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/individuals/{id}": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "input only the fields you need to update.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Individual Customers" ], "summary": "Update an individual customer", "parameters": [ { "type": "integer", "description": "customer Id", "name": "id", "in": "path", "required": true }, { "type": "boolean", "description": "if the flag is present, then the previous card number value gets saved as an old card number", "name": "preserveOldCardNumber", "in": "query" }, { "description": "customer", "name": "customer", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.UpdateIndividualRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/individuals/{id}/turn-into-business": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Name and typeId are mandatory.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Individual Customers" ], "summary": "Turn an individual customer into a business customer", "parameters": [ { "type": "integer", "description": "customer Id", "name": "id", "in": "path", "required": true }, { "type": "boolean", "description": "if the flag is present, then the previous card number value gets saved as an old card number", "name": "preserveOldCardNumber", "in": "query" }, { "description": "customer", "name": "customer", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.UpdateCompanyRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/sync": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Customers" ], "summary": "Sync customers", "parameters": [ { "type": "integer", "description": "Unix Timestamp of the last successful sync. ", "name": "lastModified", "in": "query" }, { "type": "integer", "description": "the ID of the last record in the previous response. It is the responsibility of the API client to extract this value and use it for the next call.", "name": "lastIdRetrieved", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.CustomerResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/tags": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Retrieve tags of customers", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tags" ], "summary": "Get customers tags", "parameters": [ { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "link Ids", "name": "ids", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "tag Ids", "name": "tagIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "customer Ids", "name": "customerIds", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.TagToCustomerLinkResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } }, "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tags" ], "summary": "Attach tag to a customer", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.TagToCustomerLinkRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/types": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Retrieve customer types, only business customers can have these types attached.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Business Customer Types" ], "summary": "Get business customer types", "parameters": [ { "type": "string", "description": "match type of the filtering. Supported values: `=`, `\u003e=`, `\u003c=`, `contains`, `startswith`. Default is `=`", "name": "match", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "customer type Ids", "name": "ids", "in": "query" }, { "type": "integer", "description": "Retrieve only items that have been added or modified at/after/before a specified timestamp. Use it to keep a local database in sync with Erply.", "name": "changed", "in": "query" }, { "type": "integer", "description": "customer type's order", "name": "order", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.CompanyTypeResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/customers/{customerId}/tags/{tagId}": { "delete": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Remove a tag from a customer", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tags" ], "summary": "Remove a tag from a customer", "parameters": [ { "type": "integer", "description": "tag Id", "name": "tagId", "in": "path", "required": true }, { "type": "integer", "description": "customer Id", "name": "customerId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.BulkResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/loyalty-cards/old-numbers": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Loyalty Cards" ], "summary": "Get old card numbers", "parameters": [ { "type": "string", "description": "match type of the filtering. Supported values: `=`, `\u003e=`, `\u003c=`, `contains`, `startswith`. Default is `=`", "name": "match", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "old card number ids", "name": "ids", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "customer ids", "name": "customerIds", "in": "query" }, { "type": "string", "description": "card number", "name": "cardNumber", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.OldCardNumberResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } }, "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Create an old card number", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Loyalty Cards" ], "summary": "Create an old card number", "parameters": [ { "description": "oldCardNumRequest", "name": "oldCardNumRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.CreateOldCardNumberRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/loyalty-cards/old-numbers/{ids}": { "delete": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Loyalty Cards" ], "summary": "Delete old card numbers", "parameters": [ { "type": "string", "description": "up to 100 semicolon delimited old card number ids", "name": "ids", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.BulkResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/loyalty-cards/old-numbers/{id}": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Loyalty Cards" ], "summary": "Update an old card number", "parameters": [ { "type": "integer", "description": "old card number id", "name": "id", "in": "path", "required": true }, { "description": "oldCardNumRequest", "name": "oldCardNumRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.UpdateOldCardNumberRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/offline-db/sync/customers": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Get customers that have been added or modified since the specified timestamp. Fetches only the columns that are actually needed for the Offline Database.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Special Endpoints" ], "summary": "Get Customers for Offline DB to sync", "parameters": [ { "type": "integer", "description": "Last modification time (create/update)", "name": "lastModified", "in": "query", "required": true }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 8000 for this special endpoint", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_server_graph_model.OfflineDbCustomer" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/tags": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Retrieve the tags", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tags" ], "summary": "Get tags", "parameters": [ { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "tag Ids", "name": "ids", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.TagResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } }, "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Create a tag", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tags" ], "summary": "Create a tag", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.TagRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/tags/groups": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Retrieve the groups of tags", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tag Groups" ], "summary": "Get groups of tags", "parameters": [ { "type": "string", "description": "match type of the filtering. Supported values: `=`, `\u003e=`, `\u003c=`, `contains`, `startswith`. Default is `=`", "name": "match", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "group of tags Ids", "name": "ids", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" }, { "type": "boolean", "description": "optionally return total number of records in the X-Total-Count response header", "name": "withTotalCount", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.TagGroupResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } }, "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Create a group of tags", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tag Groups" ], "summary": "Create a group of tags", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.TagGroupRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/tags/groups/tags": { "get": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Retrieve the tags in groups", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tag Groups" ], "summary": "Get tags in groups", "parameters": [ { "type": "string", "description": "match type of the filtering. Supported values: `=`, `\u003e=`, `\u003c=`, `contains`, `startswith`. Default is `=`", "name": "match", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "link Ids", "name": "ids", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "tag Ids", "name": "tagIds", "in": "query" }, { "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv", "description": "group Ids", "name": "groupIds", "in": "query" }, { "type": "string", "description": "field to order by", "name": "orderBy", "in": "query" }, { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction to order by", "name": "orderByDirection", "in": "query" }, { "type": "integer", "description": "skip n records", "name": "skip", "in": "query" }, { "type": "integer", "description": "items to take, default: 20, max: 100000", "name": "take", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.TagToGroupLinkResponse" } }, "headers": { "X-Total-Count": { "type": "uint", "description": "total number of records (ignores skip \u0026 take parameters)" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } }, "post": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Add tag to a group", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tag Groups" ], "summary": "Add tag to a group", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.TagToGroupLinkRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/tags/groups/{ids}": { "delete": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tag Groups" ], "summary": "Delete groups of tags", "parameters": [ { "type": "string", "description": "up to 100 semicolon delimited tag group Ids", "name": "ids", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.BulkResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/tags/groups/{id}": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tag Groups" ], "summary": "Update a group of tags", "parameters": [ { "type": "integer", "description": "group of tags Id", "name": "id", "in": "path", "required": true }, { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.TagGroupRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/tags/{ids}": { "delete": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tags" ], "summary": "Delete tags", "parameters": [ { "type": "string", "description": "up to 100 semicolon delimited tag Ids", "name": "ids", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.BulkResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/tags/{id}": { "patch": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tags" ], "summary": "Update a tag", "parameters": [ { "type": "integer", "description": "tag Id", "name": "id", "in": "path", "required": true }, { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/customers-api_internal_models.TagRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } }, "/v1/tags/{tagId}/groups/{groupId}": { "delete": { "security": [ { "sk": [] }, { "cc": [] }, { "jwt": [] } ], "description": "Remove a tag from a group", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Tag Groups" ], "summary": "Remove a tag from a group", "parameters": [ { "type": "integer", "description": "tag Id", "name": "tagId", "in": "path", "required": true }, { "type": "integer", "description": "group Id", "name": "groupId", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/responses.Response" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/responses.MessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/responses.MessageResponse" } } } } } }, "definitions": { "ExternalIDResponse": { "type": "object", "properties": { "added": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "addedby_id": { "description": "user ID", "type": "integer", "example": 1 }, "changed": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "changedby_id": { "description": "user ID", "type": "integer", "example": 1 }, "customerId": { "type": "integer" }, "externalId": { "type": "string" }, "integrationName": { "type": "string" } } }, "customers-api_internal_models.AddCustomersToGroupRequest": { "type": "object", "properties": { "customerIDs": { "type": "array", "items": { "type": "integer" } } } }, "customers-api_internal_models.AddressTypeResponse": { "type": "object", "properties": { "added": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "addedBy": { "description": "username", "type": "string", "example": "k@erp.xyz" }, "changed": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "changedBy": { "description": "username", "type": "string", "example": "k@erp.xyz" }, "id": { "description": "object ID", "type": "integer", "example": 1234 }, "isActivelyUsed": { "type": "boolean" }, "name": { "$ref": "#/definitions/models.Translatable" } } }, "customers-api_internal_models.AttributeRequest": { "type": "object", "properties": { "entity": { "description": "Entity name of the record", "type": "string", "example": "customer group" }, "id": { "description": "ID of the attribute", "type": "integer" }, "name": { "description": "name of the attribute", "type": "string", "example": "is_good" }, "record_id": { "description": "ID of the record", "type": "integer", "example": 7 }, "type": { "description": "3 types are available - int, double, text", "type": "string", "example": "int" }, "value": { "description": "based on the type value should be number of text" } } }, "customers-api_internal_models.AttributeResponse": { "type": "object", "properties": { "entity": { "description": "Entity name of the record", "type": "string", "example": "customer" }, "id": { "description": "ID of the attribute", "type": "integer", "example": 33 }, "name": { "type": "string", "example": "is_good" }, "record_id": { "description": "ID of the database record", "type": "integer", "example": 7 }, "type": { "description": "3 types are available - int, double, text", "type": "string", "example": "text" }, "value": { "description": "based on the type value can be number of text" } } }, "customers-api_internal_models.BusinessAreaRequest": { "type": "object", "properties": { "name": { "$ref": "#/definitions/models.Translatable" } } }, "customers-api_internal_models.BusinessAreaResponse": { "type": "object", "properties": { "added": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "addedBy": { "description": "username", "type": "string", "example": "k@erp.xyz" }, "changed": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "changedBy": { "description": "username", "type": "string", "example": "k@erp.xyz" }, "id": { "description": "object ID", "type": "integer", "example": 1234 }, "name": { "$ref": "#/definitions/models.Translatable" } } }, "customers-api_internal_models.BusinessCustomerResponse": { "type": "object", "properties": { "GLN": { "description": "Global Location Number.", "type": "string", "example": "901234500004" }, "added": { "type": "integer" }, "bankAccountNumber": { "description": "Number of customer's bank account.", "type": "string" }, "bankIban": { "description": "IBAN number of customer's bank account.", "type": "string" }, "bankName": { "description": "Name of customer's bank.", "type": "string" }, "bankSwiftCode": { "description": "BIC/SWIFT identifier of customer's bank account.", "type": "string" }, "businessAreaId": { "description": "area of business.", "type": "integer" }, "changed": { "type": "integer" }, "changedBy": { "type": "string" }, "changedByEmployeeId": { "type": "integer" }, "code": { "description": "Registry code", "type": "string" }, "color": { "description": "Color that the customer entry is marked with. Possible values: \"\", \"yellow\", \"red\", \"blue\", \"green\".", "type": "string" }, "countryId": { "description": "Customer’s country. Use PIM API or Erply Classic API to get this ID", "type": "integer" }, "creditLimit": { "description": "Customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe.", "type": "integer" }, "customerBalanceDisabled": { "description": "Flag indicating that Erply does not keep track of the customer's balance (amount prepaid or due)", "type": "boolean" }, "customerGroupId": { "type": "integer" }, "customerManagerId": { "description": "Customer manager (must be an employee)", "type": "integer" }, "defaultPaymentDeadLine": { "description": "Default payment deadline (in days).", "type": "integer" }, "deliveryTypeId": { "description": "A field that propagates from customer records to sales documents and lets the company categorize shipments by delivery method or delivery time.", "type": "integer" }, "displayedName": { "description": "Name with customer type", "type": "string" }, "doNotSell": { "description": "Whether the customer is marked with a do not sell flag or not.", "type": "boolean" }, "eInvoiceEmail": { "description": "In UI, the field is titled “E-invoice email address”.", "type": "string" }, "eInvoiceReference": { "description": "Customer reference for e-invoices.", "type": "string" }, "eInvoicesViaEmailEnabled": { "description": "whether the customer wants to receive invoices via electronic channels.", "type": "boolean" }, "ediCode": { "description": "E-invoice integration parameter.", "type": "string" }, "ediType": { "description": "EDI type. Possible values: 2DOC, 4DOC, SPECIAL.", "type": "string" }, "emailOptOut": { "description": "Flag indicating that this customer does not want to receive email correspondence.", "type": "boolean" }, "facebookName": { "type": "string" }, "factoringContractNumber": { "description": "Factoring contract number.", "type": "string" }, "fax": { "type": "string" }, "fullName": { "type": "string" }, "gender": { "description": "Gender. Erply API only accepts \"male\" \"female\" or an empty string.", "type": "string", "example": "male" }, "homeStoreCustomId": { "description": "Additional, custom home store ID", "type": "integer" }, "homeStoreId": { "description": "Location where the customer shops most frequently. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "id": { "type": "integer" }, "integrationCode": { "description": "Corresponding customer identifier in a system integrated with Erply (e.g. accounting software)", "type": "string" }, "invoicesViaDocuraEnabled": { "description": "whether the customer wants to receive invoices via docura.", "type": "boolean" }, "invoicesViaEmailEnabled": { "description": "whether the customer wants to receive invoices via email.", "type": "boolean" }, "isStarred": { "description": "Mark if a customer should be starred", "type": "boolean" }, "loyaltyCardNumber": { "description": "Assign the code of customer's loyalty/membership card. This code must match the sequence produced by card swipe.", "type": "string" }, "mail": { "type": "string" }, "mobile": { "type": "string" }, "name": { "description": "Name.", "type": "string" }, "notes": { "type": "string" }, "operatorId": { "description": "E-invoice integration parameter.", "type": "string" }, "paperMailsEnabled": { "description": "whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).", "type": "boolean" }, "partialTaxExemption": { "type": "boolean" }, "payerId": { "description": "“Payer of invoices” (another customer).", "type": "integer" }, "paysViaFactoring": { "description": "Flag indicating that this customer pays via factoring (all invoices must be addressed to a designated third party)", "type": "boolean" }, "penaltyForOverdue": { "description": "Late fee / penalty for overdue invoices.\nThe semantic meaning of this value is not strictly defined; usually we expect it to be “% per day”", "type": "number" }, "peppolId": { "description": "Peppol ID", "type": "string" }, "phone": { "type": "string" }, "posCouponsDisabled": { "description": "Flag indicating that coupons must not be automatically printed to this customer.", "type": "boolean" }, "pricelistId": { "description": "Assign the customer a price list", "type": "integer" }, "pricelistId2": { "type": "integer" }, "pricelistId3": { "type": "integer" }, "pricelistId4": { "type": "integer" }, "pricelistId5": { "type": "integer" }, "primaryStoreId": { "description": "ID of the primary store", "type": "integer" }, "referenceNumber": { "description": "Customer’s reference number for sales invoices.\n\tAssign a reference number - if system is configured to use hand-created customer reference numbers.\n\tBy default, not necessary, since reference numbers are created automatically.", "type": "string" }, "rewardPointsDisabled": { "description": "Flag indicating that the customer will not earn points for purchases. (They can still spend existing points though.)", "type": "boolean" }, "salesForCashOnly": { "description": "Flag “Sales for cash only”. By default, false", "type": "boolean" }, "secondaryStoreId": { "description": "ID of the secondary store", "type": "integer" }, "shipGoodsWithWaybills": { "description": "A flag indicating that this customer wants to get goods with Waybills, not Invoice-Waybills.", "type": "boolean" }, "signUpStoreId": { "description": "Location where the customer signed up. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "skype": { "type": "string" }, "taxExempt": { "description": "Flag indicating that this customer must not be charged sales tax.", "type": "boolean" }, "taxofficeId": { "description": "Feature used by Greek customers: office where the customer / supplier reports to. (This value must be shown on some printouts.)", "type": "integer" }, "twitterId": { "type": "string" }, "type": { "description": "Customer type. Possible values are \"DOMESTIC\", \"EU\", \"OUTSIDE_EU\", \"EU_WITH_VAT", "type": "string" }, "typeId": { "type": "integer" }, "vatNumber": { "description": "Customer's VAT number.", "type": "string" }, "webShopUsername": { "description": "This is for web shop integrations: to store customers' web-shop login credentials in Erply.", "type": "string" }, "website": { "type": "string" } } }, "customers-api_internal_models.CompanyTypeResponse": { "type": "object", "properties": { "abbreviation": { "$ref": "#/definitions/models.Translatable" }, "added": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "addedBy": { "description": "username", "type": "string", "example": "k@erp.xyz" }, "changed": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "changedBy": { "description": "username", "type": "string", "example": "k@erp.xyz" }, "id": { "description": "object ID", "type": "integer", "example": 1234 }, "name": { "$ref": "#/definitions/models.Translatable" }, "order": { "type": "integer", "example": 15 } } }, "customers-api_internal_models.CreateAddressRequest": { "type": "object", "properties": { "address2": { "description": "Street address, line 2. This field is exposed via Erply user interface only for US, CA and MX accounts!", "type": "string" }, "city": { "description": "City, region, or county", "type": "string", "example": "Spring" }, "country": { "type": "string", "example": "US" }, "customerId": { "type": "integer" }, "postCode": { "description": "Postal code or ZIP code.", "type": "string", "example": "77386" }, "state": { "description": "State. This field is exposed via Erply user interface only for US, CA and MX accounts!", "type": "string", "example": "TX" }, "street": { "description": "Street address.\nIf address cannot be split into parts, put the whole address into this field.", "type": "string", "example": "3757 Richland Avenue" }, "typeId": { "type": "integer" } } }, "customers-api_internal_models.CreateCompanyRequest": { "type": "object", "properties": { "GLN": { "description": "Global Location Number.", "type": "string", "example": "901234500004" }, "bankAccountNumber": { "description": "Number of customer's bank account.", "type": "string" }, "bankIban": { "description": "IBAN number of customer's bank account.", "type": "string" }, "bankName": { "description": "name of customer's bank.", "type": "string" }, "bankSwiftCode": { "description": "BIC/SWIFT identifier of customer's bank account.", "type": "string" }, "businessAreaId": { "description": "area of business.", "type": "integer" }, "code": { "description": "Registry code", "type": "string" }, "color": { "description": "Color that the customer entry is marked with. Possible values: \"\", \"yellow\", \"red\", \"blue\", \"green\".", "type": "string" }, "countryId": { "description": "Customer’s country.", "type": "integer" }, "creditLimit": { "description": "Customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe.", "type": "integer" }, "customerBalanceDisabled": { "description": "Flag indicating that Erply does not keep track of the customer's balance (amount prepaid or due)", "type": "boolean" }, "customerGroupId": { "type": "integer" }, "customerManagerId": { "description": "Customer manager (must be an employee)", "type": "integer" }, "defaultPaymentDeadLine": { "description": "Default payment deadline (in days).", "type": "integer" }, "deliveryTypeId": { "description": "A field that propagates from customer records to sales documents and lets the company categorize shipments by delivery method or delivery time.", "type": "integer" }, "doNotSell": { "description": "Whether the customer is marked with a do not sell flag or not.", "type": "boolean" }, "eInvoiceEmail": { "description": "In UI, the field is titled “E-invoice email address”.", "type": "string" }, "eInvoiceReference": { "description": "Customer reference for e-invoices.", "type": "string" }, "eInvoicesViaEmailEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via electronic channels.", "type": "boolean" }, "ediCode": { "description": "E-invoice integration parameter.", "type": "string" }, "ediType": { "description": "EDI type. Possible values: 2DOC, 4DOC, SPECIAL.", "type": "string" }, "emailOptOut": { "description": "Flag indicating that this customer does not want to receive email correspondence.", "type": "boolean" }, "employeeId": { "description": "Employee ID of the employee creating this company customer.", "type": "integer" }, "facebookName": { "type": "string" }, "factoringContractNumber": { "description": "Factoring contract number.", "type": "string" }, "fax": { "type": "string" }, "gender": { "description": "Gender. Erply API only accepts \"male\" \"female\" or an empty string.", "type": "string", "example": "male" }, "homeStoreCustomId": { "description": "Additional, custom home store ID", "type": "integer" }, "homeStoreId": { "description": "Location where the customer shops most frequently. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "integrationCode": { "description": "Corresponding customer identifier in a system integrated with Erply (e.g. accounting software)", "type": "string" }, "invoicesViaDocuraEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via docura.", "type": "boolean" }, "invoicesViaEmailEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via email.", "type": "boolean" }, "isStarred": { "description": "Mark if a customer should be starred", "type": "boolean" }, "loyaltyCardNumber": { "description": "Assign the code of customer's loyalty/membership card. This code must match the sequence produced by card swipe.", "type": "string" }, "mail": { "type": "string" }, "mobile": { "type": "string" }, "name": { "description": "Name.", "type": "string" }, "notes": { "type": "string" }, "operatorId": { "description": "E-invoice integration parameter.", "type": "string" }, "paperMailsEnabled": { "description": "0 or 1: whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).", "type": "boolean" }, "partialTaxExemption": { "type": "boolean" }, "payerId": { "description": "“Payer of invoices” (another customer).", "type": "integer" }, "paysViaFactoring": { "description": "Flag indicating that this customer pays via factoring (all invoices must be addressed to a designated third party)", "type": "boolean" }, "penaltyForOverdue": { "description": "Late fee / penalty for overdue invoices.\nThe semantic meaning of this value is not strictly defined; usually we expect it to be “% per day”", "type": "number" }, "peppolId": { "description": "Peppol ID", "type": "string" }, "phone": { "type": "string" }, "posCouponsDisabled": { "description": "Flag indicating that coupons must not be automatically printed to this customer.", "type": "boolean" }, "pricelistId": { "description": "Assign the customer a price list", "type": "integer" }, "pricelistId2": { "type": "integer" }, "pricelistId3": { "type": "integer" }, "pricelistId4": { "type": "integer" }, "pricelistId5": { "type": "integer" }, "primaryStoreId": { "description": "ID of the primary store", "type": "integer" }, "referenceNumber": { "description": "Customer’s reference number for sales invoices.\n\tAssign a reference number - if system is configured to use hand-created customer reference numbers.\n\tBy default, not necessary, since reference numbers are created automatically.", "type": "string" }, "rewardPointsDisabled": { "description": "Flag indicating that the customer will not earn points for purchases. (They can still spend existing points though.)", "type": "boolean" }, "salesForCashOnly": { "description": "Flag “Sales for cash only”. By default, false", "type": "boolean" }, "secondaryStoreId": { "description": "ID of the secondary store", "type": "integer" }, "shipGoodsWithWaybills": { "description": "A flag indicating that this customer wants to get goods with Waybills, not Invoice-Waybills.", "type": "boolean" }, "signUpStoreId": { "description": "Location where the customer signed up. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "skype": { "type": "string" }, "taxExempt": { "description": "Flag indicating that this customer must not be charged sales tax.", "type": "boolean" }, "taxofficeId": { "description": "Feature used by Greek customers: office where the customer / supplier reports to.", "type": "integer" }, "twitterId": { "type": "string" }, "type": { "description": "Customer type. Possible values are \"DOMESTIC\", \"EU\", \"OUTSIDE_EU\", \"EU_WITH_VAT\"", "type": "string" }, "typeId": { "description": "type ID can be fetched from the GET customers/types endpoint", "type": "integer" }, "vatNumber": { "description": "Customer's VAT number.", "type": "string" }, "webShopPassword": { "type": "string" }, "webShopUsername": { "description": "This is for web shop integrations: to store customers' web-shop login credentials in Erply.", "type": "string" }, "website": { "type": "string" } } }, "customers-api_internal_models.CreateCustomerGroupRequest": { "type": "object", "properties": { "name": { "$ref": "#/definitions/models.Translatable" }, "parentId": { "type": "integer" }, "priceListId": { "type": "integer" }, "priceListId2": { "type": "integer" }, "priceListId3": { "type": "integer" }, "priceListId4": { "type": "integer" }, "priceListId5": { "type": "integer" } } }, "customers-api_internal_models.CreateIndividualRequest": { "type": "object", "properties": { "GLN": { "description": "Global Location Number.", "type": "string", "example": "901234500004" }, "bankAccountNumber": { "description": "Number of customer's bank account.", "type": "string" }, "bankIban": { "description": "IBAN number of customer's bank account.", "type": "string" }, "bankName": { "description": "LastName of customer's bank.", "type": "string" }, "bankSwiftCode": { "description": "BIC/SWIFT identifier of customer's bank account.", "type": "string" }, "birthDate": { "description": "Date of birth (yyyy-mm-dd)", "type": "string", "example": "2006-01-02" }, "businessAreaId": { "description": "area of business.", "type": "integer" }, "code": { "description": "National ID", "type": "string" }, "color": { "description": "Color that the customer entry is marked with. Possible values: \"\", \"yellow\", \"red\", \"blue\", \"green\".", "type": "string" }, "countryId": { "description": "Customer’s country.", "type": "integer" }, "creditLimit": { "description": "Customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe.", "type": "integer" }, "customerBalanceDisabled": { "description": "Flag indicating that Erply does not keep track of the customer's balance (amount prepaid or due)", "type": "boolean" }, "customerGroupId": { "type": "integer" }, "customerManagerId": { "description": "Customer manager (must be an employee", "type": "integer" }, "defaultPaymentDeadLine": { "description": "Default payment deadline (in days).", "type": "integer" }, "deliveryTypeId": { "description": "A field that propagates from customer records to sales documents and lets the company categorize shipments by delivery method or delivery time.", "type": "integer" }, "doNotSell": { "description": "Whether the customer is marked with a do not sell flag or not.", "type": "boolean" }, "eInvoiceEmail": { "description": "In UI, the field is titled “E-invoice email address”.", "type": "string" }, "eInvoiceReference": { "description": "Customer reference for e-invoices.", "type": "string" }, "eInvoicesViaEmailEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via electronic channels.", "type": "boolean" }, "ediCode": { "description": "E-invoice integration parameter.", "type": "string" }, "ediType": { "description": "EDI type. Possible values: 2DOC, 4DOC, SPECIAL.", "type": "string" }, "emailOptOut": { "description": "Flag indicating that this customer does not want to receive email correspondence.", "type": "boolean" }, "employeeId": { "description": "Employee ID of the employee creating this individual customer.", "type": "integer" }, "employerId": { "description": "Used to indicate that this person is a contact person / an employee in a particular company.", "type": "integer" }, "facebookName": { "type": "string" }, "factoringContractNumber": { "description": "Factoring contract number.", "type": "string" }, "fax": { "type": "string" }, "firstName": { "description": "First name / given name.", "type": "string" }, "gender": { "description": "Gender. Erply API only accepts \"male\" \"female\" or an empty string.", "type": "string", "example": "male" }, "homeStoreCustomId": { "description": "Additional, custom home store ID", "type": "integer" }, "homeStoreId": { "description": "Location where the customer shops most frequently. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "integrationCode": { "description": "Corresponding customer identifier in a system integrated with Erply (e.g. accounting software)", "type": "string" }, "invoicesViaDocuraEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via docura.", "type": "boolean" }, "invoicesViaEmailEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via email.", "type": "boolean" }, "isStarred": { "description": "Mark if a customer should be starred", "type": "boolean" }, "jobTitleId": { "description": "Individual's job title Id", "type": "integer" }, "lastName": { "description": "Last name / family name.", "type": "string" }, "loyaltyCardNumber": { "description": "Assign the code of customer's loyalty/membership card. This code must match the sequence produced by card swipe.", "type": "string" }, "mail": { "type": "string" }, "mobile": { "type": "string" }, "notes": { "type": "string" }, "operatorId": { "description": "E-invoice integration parameter.", "type": "string" }, "paperMailsEnabled": { "description": "0 or 1: whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).", "type": "boolean" }, "partialTaxExemption": { "type": "boolean" }, "payerId": { "description": "“Payer of invoices” (another customer).", "type": "integer" }, "paysViaFactoring": { "description": "Flag indicating that this customer pays via factoring (all invoices must be addressed to a designated third party)", "type": "boolean" }, "penaltyForOverdue": { "description": "Late fee / penalty for overdue invoices.\nThe semantic meaning of this value is not strictly defined; usually we expect it to be “% per day”", "type": "number" }, "peppolId": { "description": "Peppol ID", "type": "string" }, "phone": { "type": "string" }, "posCouponsDisabled": { "description": "Flag indicating that coupons must not be automatically printed to this customer.", "type": "boolean" }, "priceListId": { "description": "Assign the customer a price list", "type": "integer" }, "priceListId2": { "type": "integer" }, "priceListId3": { "type": "integer" }, "priceListId4": { "type": "integer" }, "priceListId5": { "type": "integer" }, "primaryStoreId": { "description": "ID of the primary store", "type": "integer" }, "referenceNumber": { "description": "Customer’s reference number for sales invoices.\n\tAssign a reference number - if system is configured to use hand-created customer reference numbers.\n\tBy default, not necessary, since reference numbers are created automatically.", "type": "string" }, "rewardPointsDisabled": { "description": "Flag indicating that the customer will not earn points for purchases. (They can still spend existing points though.)", "type": "boolean" }, "salesForCashOnly": { "description": "Flag “Sales for cash only”. By default,false", "type": "boolean" }, "secondaryStoreId": { "description": "ID of the secondary store", "type": "integer" }, "shipGoodsWithWaybills": { "description": "A flag indicating that this customer wants to get goods with Waybills, not Invoice-Waybills.", "type": "boolean" }, "signUpStoreId": { "description": "Location where the customer signed up. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "skype": { "type": "string" }, "taxExempt": { "description": "Flag indicating that this customer must not be charged sales tax.", "type": "boolean" }, "taxOfficeId": { "description": "Feature used by Greek customers: office where the customer / supplier reports to.", "type": "integer" }, "titleId": { "description": "A title (Mr / Mrs / Miss) etc.", "type": "integer" }, "twitterId": { "type": "string" }, "type": { "description": "Customer type. Possible values are \"DOMESTIC\", \"EU\", \"OUTSIDE_EU\", \"EU_WITH_VAT\"", "type": "string", "example": "DOMESTIC" }, "vatNumber": { "description": "Customer's VAT number.", "type": "string" }, "webShopPassword": { "type": "string" }, "webShopUsername": { "description": "This is for web shop integrations: to store customers' web-shop login credentials in Erply.", "type": "string" }, "website": { "type": "string" } } }, "customers-api_internal_models.CreateOldCardNumberRequest": { "type": "object", "properties": { "cardNumber": { "type": "string", "example": "1234-5678" }, "customerId": { "type": "integer" } } }, "customers-api_internal_models.CustomerAddressResponse": { "type": "object", "properties": { "added": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "addedBy": { "description": "username", "type": "string", "example": "k@erp.xyz" }, "address2": { "description": "Street address, line 2. This field is exposed via Erply user interface only for US, CA and MX accounts!", "type": "string" }, "changed": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "changedBy": { "description": "username", "type": "string", "example": "k@erp.xyz" }, "city": { "type": "string" }, "country": { "type": "string" }, "customerId": { "type": "integer" }, "id": { "description": "object ID", "type": "integer", "example": 1234 }, "postCode": { "description": "Postal code or ZIP code.", "type": "string" }, "state": { "description": "State. This field is exposed via Erply user interface only for US, CA and MX accounts!", "type": "string" }, "street": { "description": "Street address.\nIf address cannot be split into parts, put the whole address into this field.", "type": "string" }, "typeId": { "type": "integer" } } }, "customers-api_internal_models.CustomerGroupResponse": { "type": "object", "properties": { "added": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "addedby": { "description": "username", "type": "string", "example": "k@erp.xyz" }, "changed": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "changedby": { "description": "username", "type": "string", "example": "k@erp.xyz" }, "id": { "description": "object ID", "type": "integer", "example": 1234 }, "name": { "$ref": "#/definitions/models.Translatable" }, "order": { "type": "integer" }, "parentId": { "type": "integer" }, "priceListId": { "type": "integer" }, "priceListId2": { "type": "integer" }, "priceListId3": { "type": "integer" }, "priceListId4": { "type": "integer" }, "priceListId5": { "type": "integer" } } }, "customers-api_internal_models.CustomerResponse": { "type": "object", "properties": { "GLN": { "description": "Global Location Number.", "type": "string", "example": "901234500004" }, "added": { "type": "integer" }, "bankAccountNumber": { "description": "Number of customer's bank account.", "type": "string" }, "bankIban": { "description": "IBAN number of customer's bank account.", "type": "string" }, "bankName": { "description": "Name of customer's bank.", "type": "string" }, "bankSwiftCode": { "description": "BIC/SWIFT identifier of customer's bank account.", "type": "string" }, "birthDate": { "description": "Person's birthday (yyyy-mm-dd)", "type": "string" }, "businessAreaId": { "description": "area of business.", "type": "integer" }, "businessName": { "description": "For businesses only.", "type": "string" }, "businessTypeId": { "description": "Customer type ID, for businesses only.", "type": "integer" }, "changed": { "type": "integer" }, "changedBy": { "type": "string" }, "changedByEmployeeId": { "type": "integer" }, "code": { "description": "National ID", "type": "string" }, "color": { "description": "Color that the customer entry is marked with. Possible values: \"\", \"yellow\", \"red\", \"blue\", \"green\".", "type": "string" }, "countryId": { "description": "Customer’s country.", "type": "integer" }, "creditLimit": { "description": "Customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe.", "type": "integer" }, "customerBalanceDisabled": { "description": "Flag indicating that Erply does not keep track of the customer's balance (amount prepaid or due)", "type": "boolean" }, "customerGroupId": { "type": "integer" }, "customerManagerId": { "description": "Customer manager (must be an employee)", "type": "integer" }, "customerType": { "description": "COMPANY or PERSON.\n For businesses, the following ributes are set: fullName, businessName (both have the same value).\n For individuals, the following attributes are set: fullName, firstName, lastName. fullName is a combination of latter two: \"lastName, firstName\".\nfullName can be used for displaying customer's name wherever needed.\n Companies should have one name field and the attribute that is edited should be businessName.\n Persons should have separate fields for given name and surname (respective attributes: firstName, lastName).", "type": "string" }, "defaultPaymentDeadLine": { "description": "Default payment deadline (in days).", "type": "integer" }, "deliveryTypeId": { "description": "A field that propagates from customer records to sales documents and lets the company categorize shipments by delivery method or delivery time.", "type": "integer" }, "displayedName": { "description": "Name with customer type", "type": "string" }, "doNotSell": { "description": "Whether the customer is marked with a do not sell flag or not.", "type": "boolean" }, "eInvoiceEmail": { "description": "In UI, the field is titled “E-invoice email address”.", "type": "string" }, "eInvoiceReference": { "description": "Customer reference for e-invoices.", "type": "string" }, "eInvoicesViaEmailEnabled": { "description": "whether the customer wants to receive invoices via electronic channels.", "type": "boolean" }, "ediCode": { "description": "E-invoice integration parameter.", "type": "string" }, "ediType": { "description": "EDI type. Possible values: 2DOC, 4DOC, SPECIAL.", "type": "string" }, "emailOptOut": { "description": "Flag indicating that this customer does not want to receive email correspondence.", "type": "boolean" }, "employerId": { "description": "Used to indicate that this individual is a contact person / an employee in a particular business.", "type": "integer" }, "facebookName": { "type": "string" }, "factoringContractNumber": { "description": "Factoring contract number.", "type": "string" }, "fax": { "type": "string" }, "firstName": { "description": "First name / given name. For individuals only.", "type": "string" }, "fullName": { "description": "Full name of the customer, use for displaying customer name.", "type": "string" }, "gender": { "description": "Gender. Erply API only accepts \"male\" \"female\" or an empty string.", "type": "string", "example": "male" }, "homeStoreCustomId": { "description": "Additional, custom home store ID", "type": "integer" }, "homeStoreId": { "description": "Location where the customer shops most frequently. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "id": { "type": "integer" }, "integrationCode": { "description": "Corresponding customer identifier in a system integrated with Erply (e.g. accounting software)", "type": "string" }, "invoicesViaDocuraEnabled": { "description": "Whether the customer wants to receive invoices via Docura channels.", "type": "boolean" }, "invoicesViaEmailEnabled": { "description": "whether the customer wants to receive invoices via email.", "type": "boolean" }, "isStarred": { "description": "Mark if a customer should be starred", "type": "boolean" }, "jobTitleId": { "description": "Individual's job title Ids.", "type": "integer" }, "lastName": { "description": "Last name / family name. For individuals only.", "type": "string" }, "loyaltyCardNumber": { "description": "Assign the code of customer's loyalty/membership card. This code must match the sequence produced by card swipe.", "type": "string" }, "mail": { "type": "string" }, "mobile": { "type": "string" }, "name": { "description": "For businesses only.", "type": "string" }, "notes": { "type": "string" }, "operatorId": { "description": "E-invoice integration parameter.", "type": "string" }, "paperMailsEnabled": { "description": "whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).", "type": "boolean" }, "partialTaxExemption": { "type": "boolean" }, "payerId": { "description": "“Payer of invoices” (another customer).", "type": "integer" }, "paysViaFactoring": { "description": "Flag indicating that this customer pays via factoring (all invoices must be addressed to a designated third party)", "type": "boolean" }, "penaltyForOverdue": { "description": "Late fee / penalty for overdue invoices.\nThe semantic meaning of this value is not strictly defined; usually we expect it to be “% per day”", "type": "number" }, "peppolId": { "description": "Peppol ID", "type": "string" }, "phone": { "type": "string" }, "posCouponsDisabled": { "description": "Flag indicating that coupons must not be automatically printed to this customer.", "type": "boolean" }, "priceListId": { "description": "Assign the customer a price list", "type": "integer" }, "priceListId2": { "type": "integer" }, "priceListId3": { "type": "integer" }, "priceListId4": { "type": "integer" }, "priceListId5": { "type": "integer" }, "primaryStoreId": { "description": "ID of the primary store", "type": "integer" }, "referenceNumber": { "description": "Customer’s reference number for sales invoices.\n\tAssign a reference number - if system is configured to use hand-created customer reference numbers.\n\tBy default,not necessary, since reference numbers are created automatically.", "type": "string" }, "rewardPointsDisabled": { "description": "Flag indicating that the customer will not earn points for purchases. (They can still spend existing points though.)", "type": "boolean" }, "salesForCashOnly": { "description": "Flag “Sales for cash only”. By default,false", "type": "boolean" }, "secondaryStoreId": { "description": "ID of the secondary store", "type": "integer" }, "shipGoodsWithWaybills": { "description": "A flag indicating that this customer wants to get goods with Waybills, not Invoice-Waybills.", "type": "boolean" }, "signUpStoreId": { "description": "Location where the customer signed up. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "skype": { "type": "string" }, "taxExempt": { "description": "Flag indicating that this customer must not be charged sales tax.", "type": "boolean" }, "taxOfficeId": { "description": "Feature used by Greek customers: office where the customer / supplier reports to. (This value must be shown on some printouts.)", "type": "integer" }, "titleId": { "description": "A title (Mr / Mrs / Miss) etc.", "type": "integer" }, "twitterId": { "type": "string" }, "type": { "description": "Customer type. Possible values are \"DOMESTIC\", \"EU\", \"OUTSIDE_EU\", \"EU_WITH_VAT", "type": "string" }, "vatNumber": { "description": "Customer's VAT number.", "type": "string" }, "webShopUsername": { "description": "This is for web shop integrations: to store customers' web-shop login credentials in Erply.", "type": "string" }, "website": { "type": "string" } } }, "customers-api_internal_models.ExternalIDRequest": { "type": "object", "properties": { "externalId": { "type": "string", "example": "17" }, "integrationName": { "type": "string", "example": "Shopify" } } }, "customers-api_internal_models.IndividualCustomerResponse": { "type": "object", "properties": { "GLN": { "description": "Global Location Number.", "type": "string", "example": "901234500004" }, "added": { "type": "integer" }, "bankAccountNumber": { "description": "Number of customer's bank account.", "type": "string" }, "bankIban": { "description": "IBAN number of customer's bank account.", "type": "string" }, "bankName": { "description": "Name of customer's bank.", "type": "string" }, "bankSwiftCode": { "description": "BIC/SWIFT identifier of customer's bank account.", "type": "string" }, "birthDate": { "description": "Date of birth (yyyy-mm-dd)", "type": "string" }, "businessAreaId": { "description": "area of business.", "type": "integer" }, "changed": { "type": "integer" }, "changedBy": { "type": "string" }, "changedByEmployeeId": { "type": "integer" }, "code": { "description": "National ID", "type": "string" }, "color": { "description": "Color that the customer entry is marked with. Possible values: \"\", \"yellow\", \"red\", \"blue\", \"green\".", "type": "string" }, "countryId": { "description": "Customer’s country.", "type": "integer" }, "creditLimit": { "description": "Customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe.", "type": "integer" }, "customerBalanceDisabled": { "description": "Flag indicating that Erply does not keep track of the customer's balance (amount prepaid or due)", "type": "boolean" }, "customerGroupId": { "type": "integer" }, "customerManagerId": { "description": "Customer manager (must be an employee)", "type": "integer" }, "defaultPaymentDeadLine": { "description": "Default payment deadline (in days).", "type": "integer" }, "deliveryTypeId": { "description": "A field that propagates from customer records to sales documents and lets the company categorize shipments by delivery method or delivery time.", "type": "integer" }, "displayedName": { "description": "Name with customer type", "type": "string" }, "doNotSell": { "description": "Whether the customer is marked with a do not sell flag or not.", "type": "boolean" }, "eInvoiceEmail": { "description": "In UI, the field is titled “E-invoice email address”.", "type": "string" }, "eInvoiceReference": { "description": "Customer reference for e-invoices.", "type": "string" }, "eInvoicesViaEmailEnabled": { "description": "whether the customer wants to receive invoices via electronic channels.", "type": "boolean" }, "ediCode": { "description": "E-invoice integration parameter.", "type": "string" }, "ediType": { "description": "EDI type. Possible values: 2DOC, 4DOC, SPECIAL.", "type": "string" }, "emailOptOut": { "description": "Flag indicating that this customer does not want to receive email correspondence.", "type": "boolean" }, "employerId": { "description": "Used to indicate that this person is a contact person / an employee in a particular company.", "type": "integer" }, "facebookName": { "type": "string" }, "factoringContractNumber": { "description": "Factoring contract number.", "type": "string" }, "fax": { "type": "string" }, "firstName": { "description": "First name / given name.", "type": "string" }, "fullName": { "description": "First name and Last name", "type": "string" }, "gender": { "description": "Gender. Erply API only accepts \"male\" \"female\" or an empty string.", "type": "string", "example": "male" }, "homeStoreCustomId": { "description": "Additional, custom home store ID", "type": "integer" }, "homeStoreId": { "description": "Location where the customer shops most frequently. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "id": { "type": "integer" }, "integrationCode": { "description": "Corresponding customer identifier in a system integrated with Erply (e.g. accounting software)", "type": "string" }, "invoicesViaDocuraEnabled": { "description": "whether the customer wants to receive invoices via docura.", "type": "boolean" }, "invoicesViaEmailEnabled": { "description": "whether the customer wants to receive invoices via email.", "type": "boolean" }, "isStarred": { "description": "Mark if a customer should be starred", "type": "boolean" }, "jobTitleId": { "description": "Individual's job title Ids.", "type": "integer" }, "lastName": { "description": "Last name / family name.", "type": "string" }, "loyaltyCardNumber": { "description": "Assign the code of customer's loyalty/membership card. This code must match the sequence produced by card swipe.", "type": "string" }, "mail": { "type": "string" }, "mobile": { "type": "string" }, "notes": { "type": "string" }, "operatorId": { "description": "E-invoice integration parameter.", "type": "string" }, "paperMailsEnabled": { "description": "whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).", "type": "boolean" }, "partialTaxExemption": { "type": "boolean" }, "payerId": { "description": "“Payer of invoices” (another customer).", "type": "integer" }, "paysViaFactoring": { "description": "Flag indicating that this customer pays via factoring (all invoices must be addressed to a designated third party)", "type": "boolean" }, "penaltyForOverdue": { "description": "Late fee / penalty for overdue invoices.\nThe semantic meaning of this value is not strictly defined; usually we expect it to be “% per day”", "type": "number" }, "peppolId": { "description": "Peppol ID", "type": "string" }, "phone": { "type": "string" }, "posCouponsDisabled": { "description": "Flag indicating that coupons must not be automatically printed to this customer.", "type": "boolean" }, "priceListId": { "description": "Assign the customer a price list", "type": "integer" }, "priceListId2": { "type": "integer" }, "priceListId3": { "type": "integer" }, "priceListId4": { "type": "integer" }, "priceListId5": { "type": "integer" }, "primaryStoreId": { "description": "ID of the primary store", "type": "integer" }, "referenceNumber": { "description": "Customer’s reference number for sales invoices.\n\tAssign a reference number - if system is configured to use hand-created customer reference numbers.\n\tBy default,not necessary, since reference numbers are created automatically.", "type": "string" }, "rewardPointsDisabled": { "description": "Flag indicating that the customer will not earn points for purchases. (They can still spend existing points though.)", "type": "boolean" }, "salesForCashOnly": { "description": "Flag “Sales for cash only”. By default,false", "type": "boolean" }, "secondaryStoreId": { "description": "ID of the secondary store", "type": "integer" }, "shipGoodsWithWaybills": { "description": "A flag indicating that this customer wants to get goods with Waybills, not Invoice-Waybills.", "type": "boolean" }, "signUpStoreId": { "description": "Location where the customer signed up. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "skype": { "type": "string" }, "taxExempt": { "description": "Flag indicating that this customer must not be charged sales tax.", "type": "boolean" }, "taxOfficeId": { "description": "Feature used by Greek customers: office where the customer / supplier reports to. (This value must be shown on some printouts.)", "type": "integer" }, "titleId": { "description": "A title (Mr / Mrs / Miss) etc.", "type": "integer" }, "twitterId": { "type": "string" }, "type": { "description": "Customer type. Possible values are \"DOMESTIC\", \"EU\", \"OUTSIDE_EU\", \"EU_WITH_VAT", "type": "string" }, "vatNumber": { "description": "Customer's VAT number.", "type": "string" }, "webShopUsername": { "description": "This is for web shop integrations: to store customers' web-shop login credentials in Erply.", "type": "string" }, "website": { "type": "string" } } }, "customers-api_internal_models.JobTitleRequest": { "type": "object", "properties": { "name": { "$ref": "#/definitions/models.Translatable" } } }, "customers-api_internal_models.JobTitleResponse": { "type": "object", "properties": { "added": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "addedBy": { "description": "username", "type": "string", "example": "k@erp.xyz" }, "changed": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "changedBy": { "description": "username", "type": "string", "example": "k@erp.xyz" }, "id": { "description": "object ID", "type": "integer", "example": 1234 }, "name": { "$ref": "#/definitions/models.Translatable" }, "order": { "type": "integer", "example": 15 } } }, "customers-api_internal_models.MoveRequest": { "type": "object", "properties": { "position": { "description": "Position has to be lastChild | before | after", "type": "string", "example": "after" }, "targetId": { "description": "Target Group ID represents the group that the requested group is put after, or before, or becomes the last child of", "type": "integer" } } }, "customers-api_internal_models.OldCardNumberResponse": { "type": "object", "properties": { "added": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "addedby_id": { "description": "user ID", "type": "integer", "example": 1 }, "cardNumber": { "type": "string" }, "changed": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "changedby_id": { "description": "user ID", "type": "integer", "example": 1 }, "customerId": { "type": "integer" }, "id": { "description": "object ID", "type": "integer", "example": 1234 } } }, "customers-api_internal_models.TagGroupRequest": { "type": "object", "properties": { "name": { "$ref": "#/definitions/models.Translatable" } } }, "customers-api_internal_models.TagGroupResponse": { "type": "object", "properties": { "added": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "addedby_id": { "description": "user ID", "type": "integer", "example": 1 }, "changed": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "changedby_id": { "description": "user ID", "type": "integer", "example": 1 }, "id": { "description": "object ID", "type": "integer", "example": 1234 }, "name": { "$ref": "#/definitions/models.Translatable" } } }, "customers-api_internal_models.TagRequest": { "type": "object", "properties": { "name": { "$ref": "#/definitions/models.Translatable" } } }, "customers-api_internal_models.TagResponse": { "type": "object", "properties": { "added": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "addedby_id": { "description": "user ID", "type": "integer", "example": 1 }, "changed": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "changedby_id": { "description": "user ID", "type": "integer", "example": 1 }, "id": { "description": "object ID", "type": "integer", "example": 1234 }, "name": { "$ref": "#/definitions/models.Translatable" } } }, "customers-api_internal_models.TagToCustomerLinkRequest": { "type": "object", "properties": { "customerId": { "type": "integer" }, "tagId": { "type": "integer" } } }, "customers-api_internal_models.TagToCustomerLinkResponse": { "type": "object", "properties": { "added": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "addedby_id": { "description": "user ID", "type": "integer", "example": 1 }, "changed": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "changedby_id": { "description": "user ID", "type": "integer", "example": 1 }, "customerId": { "type": "integer" }, "id": { "description": "object ID", "type": "integer", "example": 1234 }, "tagId": { "type": "integer" } } }, "customers-api_internal_models.TagToGroupLinkRequest": { "type": "object", "properties": { "groupId": { "type": "integer" }, "tagId": { "type": "integer" } } }, "customers-api_internal_models.TagToGroupLinkResponse": { "type": "object", "properties": { "added": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "addedby_id": { "description": "user ID", "type": "integer", "example": 1 }, "changed": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "changedby_id": { "description": "user ID", "type": "integer", "example": 1 }, "groupId": { "type": "integer" }, "id": { "description": "object ID", "type": "integer", "example": 1234 }, "tagId": { "type": "integer" } } }, "customers-api_internal_models.TitleRequest": { "type": "object", "properties": { "name": { "$ref": "#/definitions/models.Translatable" } } }, "customers-api_internal_models.TitleResponse": { "type": "object", "properties": { "added": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "addedBy": { "description": "username", "type": "string", "example": "k@erp.xyz" }, "changed": { "description": "Unix timestamp", "type": "integer", "example": 1595230999 }, "changedBy": { "description": "username", "type": "string", "example": "k@erp.xyz" }, "id": { "description": "object ID", "type": "integer", "example": 1234 }, "name": { "$ref": "#/definitions/models.Translatable" }, "order": { "type": "integer", "example": 15 } } }, "customers-api_internal_models.UpdateAddressRequest": { "type": "object", "properties": { "address2": { "description": "Street address, line 2. This field is exposed via Erply user interface only for US, CA and MX accounts!", "type": "string" }, "city": { "type": "string", "example": "Spring" }, "country": { "type": "string", "example": "US" }, "customerId": { "type": "integer" }, "postCode": { "description": "Postal code or ZIP code.", "type": "string", "example": "77386" }, "state": { "description": "State. This field is exposed via Erply user interface only for US, CA and MX accounts!", "type": "string", "example": "TX" }, "street": { "description": "Street address.\nIf address cannot be split into parts, put the whole address into this field.", "type": "string", "example": "3757 Richland Avenue" }, "typeId": { "type": "integer" } } }, "customers-api_internal_models.UpdateCompanyRequest": { "type": "object", "properties": { "GLN": { "description": "Global Location Number.", "type": "string" }, "bankAccountNumber": { "description": "Number of customer's bank account.", "type": "string" }, "bankIban": { "description": "IBAN number of customer's bank account.", "type": "string" }, "bankName": { "description": "Name of customer's bank.", "type": "string" }, "bankSwiftCode": { "description": "BIC/SWIFT identifier of customer's bank account.", "type": "string" }, "businessAreaId": { "description": "area of business.", "type": "integer" }, "code": { "description": "Registry code", "type": "string" }, "color": { "description": "Color that the customer entry is marked with. Possible values: \"\", \"yellow\", \"red\", \"blue\", \"green\".", "type": "string" }, "countryId": { "description": "Customer’s country.", "type": "integer" }, "creditLimit": { "description": "Customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe.", "type": "integer" }, "customerBalanceDisabled": { "description": "Flag indicating that Erply does not keep track of the customer's balance (amount prepaid or due)", "type": "boolean" }, "customerGroupId": { "type": "integer" }, "customerManagerId": { "description": "Customer manager (must be an employee", "type": "integer" }, "defaultPaymentDeadLine": { "description": "Default payment deadline (in days).", "type": "integer" }, "deliveryTypeId": { "description": "A field that propagates from customer records to sales documents and lets the company categorize shipments by delivery method or delivery time.", "type": "integer" }, "doNotSell": { "description": "Whether the customer is marked with a do not sell flag or not.", "type": "boolean" }, "eInvoiceEmail": { "description": "In UI, the field is titled “E-invoice email address”.", "type": "string" }, "eInvoiceReference": { "description": "Customer reference for e-invoices.", "type": "string" }, "eInvoicesViaEmailEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via electronic channels.", "type": "boolean" }, "ediCode": { "description": "E-invoice integration parameter.", "type": "string" }, "ediType": { "description": "EDI type. Possible values: 2DOC, 4DOC, SPECIAL.", "type": "string" }, "emailOptOut": { "description": "Flag indicating that this customer does not want to receive email correspondence.", "type": "boolean" }, "employeeId": { "description": "Employee ID of the employee changing this company customer.", "type": "integer" }, "facebookName": { "type": "string" }, "factoringContractNumber": { "description": "Factoring contract number.", "type": "string" }, "fax": { "type": "string" }, "gender": { "description": "Gender. Erply API only accepts \"male\" \"female\" or an empty string.", "type": "string" }, "homeStoreCustomId": { "description": "Additional, custom home store ID", "type": "integer" }, "homeStoreId": { "description": "Location where the customer shops most frequently. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "integrationCode": { "description": "Corresponding customer identifier in a system integrated with Erply (e.g. accounting software)", "type": "string" }, "invoicesViaDocuraEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via docura.", "type": "boolean" }, "invoicesViaEmailEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via email.", "type": "boolean" }, "isStarred": { "description": "Mark if a customer should be starred", "type": "boolean" }, "loyaltyCardNumber": { "description": "Assign the code of customer's loyalty/membership card. This code must match the sequence produced by card swipe.", "type": "string" }, "mail": { "type": "string" }, "mobile": { "type": "string" }, "name": { "description": "Name.", "type": "string" }, "notes": { "type": "string" }, "operatorId": { "description": "E-invoice integration parameter.", "type": "string" }, "paperMailsEnabled": { "description": "0 or 1: whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).", "type": "boolean" }, "partialTaxExemption": { "type": "boolean" }, "payerId": { "description": "“Payer of invoices” (another customer).", "type": "integer" }, "paysViaFactoring": { "description": "Flag indicating that this customer pays via factoring (all invoices must be addressed to a designated third party)", "type": "boolean" }, "penaltyForOverdue": { "description": "Late fee / penalty for overdue invoices.\nThe semantic meaning of this value is not strictly defined; usually we expect it to be “% per day”", "type": "number" }, "peppolId": { "description": "Peppol ID", "type": "string" }, "phone": { "type": "string" }, "posCouponsDisabled": { "description": "Flag indicating that coupons must not be automatically printed to this customer.", "type": "boolean" }, "pricelistId": { "description": "Assign the customer a price list", "type": "integer" }, "pricelistId2": { "type": "integer" }, "pricelistId3": { "type": "integer" }, "pricelistId4": { "type": "integer" }, "pricelistId5": { "type": "integer" }, "primaryStoreId": { "description": "ID of the primary store", "type": "integer" }, "referenceNumber": { "description": "Customer’s reference number for sales invoices.\n\tAssign a reference number - if system is configured to use hand-created customer reference numbers.\n\tBy default, not necessary, since reference numbers are created automatically.", "type": "string" }, "rewardPointsDisabled": { "description": "Flag indicating that the customer will not earn points for purchases. (They can still spend existing points though.)", "type": "boolean" }, "salesForCashOnly": { "description": "Flag “Sales for cash only”. By default, false", "type": "boolean" }, "secondaryStoreId": { "description": "ID of the secondary store", "type": "integer" }, "shipGoodsWithWaybills": { "description": "A flag indicating that this customer wants to get goods with Waybills, not Invoice-Waybills.", "type": "boolean" }, "signUpStoreId": { "description": "Location where the customer signed up. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "skype": { "type": "string" }, "taxExempt": { "description": "Flag indicating that this customer must not be charged sales tax.", "type": "boolean" }, "taxofficeId": { "description": "Feature used by Greek customers: office where the customer / supplier reports to. (This value must be shown on some printouts.)", "type": "integer" }, "twitterId": { "type": "string" }, "type": { "description": "Customer type. Possible values are \"DOMESTIC\", \"EU\", \"OUTSIDE_EU\".", "type": "string" }, "typeId": { "type": "integer" }, "vatNumber": { "description": "Customer's VAT number.", "type": "string" }, "webShopPassword": { "type": "string" }, "webShopUsername": { "description": "This is for web shop integrations: to store customers' web-shop login credentials in Erply.", "type": "string" }, "website": { "type": "string" } } }, "customers-api_internal_models.UpdateCustomerGroupRequest": { "type": "object", "properties": { "name": { "$ref": "#/definitions/models.Translatable" }, "parentId": { "type": "integer" }, "priceListId": { "type": "integer" }, "priceListId2": { "type": "integer" }, "priceListId3": { "type": "integer" }, "priceListId4": { "type": "integer" }, "priceListId5": { "type": "integer" } } }, "customers-api_internal_models.UpdateIndividualRequest": { "type": "object", "properties": { "GLN": { "description": "Global Location Number.", "type": "string" }, "bankAccountNumber": { "description": "Number of customer's bank account.", "type": "string" }, "bankIban": { "description": "IBAN number of customer's bank account.", "type": "string" }, "bankName": { "description": "Name of customer's bank.", "type": "string" }, "bankSwiftCode": { "description": "BIC/SWIFT identifier of customer's bank account.", "type": "string" }, "birthDate": { "description": "Date of birth (yyyy-mm-dd)", "type": "string" }, "businessAreaId": { "description": "area of business.", "type": "integer" }, "code": { "description": "National ID", "type": "string" }, "color": { "description": "Color that the customer entry is marked with. Possible values: \"\", \"yellow\", \"red\", \"blue\", \"green\".", "type": "string" }, "countryId": { "description": "Customer’s country.", "type": "integer" }, "creditLimit": { "description": "Customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe.", "type": "integer" }, "customerBalanceDisabled": { "description": "Flag indicating that Erply does not keep track of the customer's balance (amount prepaid or due)", "type": "boolean" }, "customerGroupId": { "type": "integer" }, "customerManagerId": { "description": "Customer manager (must be an employee", "type": "integer" }, "defaultPaymentDeadLine": { "description": "Default payment deadline (in days).", "type": "integer" }, "deliveryTypeId": { "description": "A field that propagates from customer records to sales documents and lets the company categorize shipments by delivery method or delivery time.", "type": "integer" }, "doNotSell": { "description": "Whether the customer is marked with a do not sell flag or not.", "type": "boolean" }, "eInvoiceEmail": { "description": "In UI, the field is titled “E-invoice email address”.", "type": "string" }, "eInvoiceReference": { "description": "Customer reference for e-invoices.", "type": "string" }, "eInvoicesViaEmailEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via electronic channels.", "type": "boolean" }, "ediCode": { "description": "E-invoice integration parameter.", "type": "string" }, "ediType": { "description": "EDI type. Possible values: 2DOC, 4DOC, SPECIAL.", "type": "string" }, "emailOptOut": { "description": "Flag indicating that this customer does not want to receive email correspondence.", "type": "boolean" }, "employeeId": { "description": "Employee ID of the employee changing this individual customer.", "type": "integer" }, "employerId": { "description": "Used to indicate that this person is a contact person / an employee in a particular company.", "type": "integer" }, "facebookName": { "type": "string" }, "factoringContractNumber": { "description": "Factoring contract number.", "type": "string" }, "fax": { "type": "string" }, "firstName": { "description": "First name / given name.", "type": "string" }, "gender": { "description": "Gender. Erply API only accepts \"male\" \"female\" or an empty string.", "type": "string" }, "homeStoreCustomId": { "description": "Additional, custom home store ID", "type": "integer" }, "homeStoreId": { "description": "Location where the customer shops most frequently. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "integrationCode": { "description": "Corresponding customer identifier in a system integrated with Erply (e.g. accounting software)", "type": "string" }, "invoicesViaDocuraEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via docura.", "type": "boolean" }, "invoicesViaEmailEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via email.", "type": "boolean" }, "isStarred": { "description": "Mark if a customer should be starred", "type": "boolean" }, "jobTitleId": { "description": "Individual's job title Ids.", "type": "integer" }, "lastName": { "description": "Last name / family name.", "type": "string" }, "loyaltyCardNumber": { "description": "Assign the code of customer's loyalty/membership card. This code must match the sequence produced by card swipe.", "type": "string" }, "mail": { "type": "string" }, "mobile": { "type": "string" }, "notes": { "type": "string" }, "operatorId": { "description": "E-invoice integration parameter.", "type": "string" }, "paperMailsEnabled": { "description": "0 or 1: whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).", "type": "boolean" }, "partialTaxExemption": { "type": "boolean" }, "payerId": { "description": "“Payer of invoices” (another customer).", "type": "integer" }, "paysViaFactoring": { "description": "Flag indicating that this customer pays via factoring (all invoices must be addressed to a designated third party)", "type": "boolean" }, "penaltyForOverdue": { "description": "Late fee / penalty for overdue invoices.\nThe semantic meaning of this value is not strictly defined; usually we expect it to be “% per day”", "type": "number" }, "peppolId": { "description": "Peppol ID", "type": "string" }, "phone": { "type": "string" }, "posCouponsDisabled": { "description": "Flag indicating that coupons must not be automatically printed to this customer.", "type": "boolean" }, "priceListId": { "description": "Assign the customer a price list", "type": "integer" }, "priceListId2": { "type": "integer" }, "priceListId3": { "type": "integer" }, "priceListId4": { "type": "integer" }, "priceListId5": { "type": "integer" }, "primaryStoreId": { "description": "ID of the primary store", "type": "integer" }, "referenceNumber": { "description": "Customer’s reference number for sales invoices.\n\tAssign a reference number - if system is configured to use hand-created customer reference numbers.\n\tBy default,not necessary, since reference numbers are created automatically.", "type": "string" }, "rewardPointsDisabled": { "description": "Flag indicating that the customer will not earn points for purchases. (They can still spend existing points though.)", "type": "boolean" }, "salesForCashOnly": { "description": "Flag “Sales for cash only”. By default,false", "type": "boolean" }, "secondaryStoreId": { "description": "ID of the secondary store", "type": "integer" }, "shipGoodsWithWaybills": { "description": "A flag indicating that this customer wants to get goods with Waybills, not Invoice-Waybills.", "type": "boolean" }, "signUpStoreId": { "description": "Location where the customer signed up. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "skype": { "type": "string" }, "taxExempt": { "description": "Flag indicating that this customer must not be charged sales tax.", "type": "boolean" }, "taxOfficeId": { "description": "Feature used by Greek customers: office where the customer / supplier reports to. (This value must be shown on some printouts.)", "type": "integer" }, "titleId": { "description": "A title (Mr / Mrs / Miss) etc.", "type": "integer" }, "twitterId": { "type": "string" }, "type": { "description": "Customer type. Possible values are \"DOMESTIC\", \"EU\", \"OUTSIDE_EU\".", "type": "string" }, "vatNumber": { "description": "Customer's VAT number.", "type": "string" }, "webShopPassword": { "type": "string" }, "webShopUsername": { "description": "This is for web shop integrations: to store customers' web-shop login credentials in Erply.", "type": "string" }, "website": { "type": "string" } } }, "customers-api_internal_models.UpdateOldCardNumberRequest": { "type": "object", "properties": { "cardNumber": { "type": "string", "example": "1234-5678" } } }, "customers-api_internal_server_graph_model.OfflineDbCustomer": { "type": "object", "properties": { "code": { "type": "string" }, "countryID": { "type": "integer" }, "creditLimit": { "type": "integer" }, "customerGroupID": { "type": "integer" }, "fullName": { "type": "string" }, "gender": { "type": "string" }, "id": { "type": "integer" }, "mail": { "type": "string" }, "mobile": { "type": "string" } } }, "customers-api_internal_services_customers_bulk.CreateCompanyRequest": { "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.CreateCompanyRequest" } } } }, "customers-api_internal_services_customers_bulk.CreateIndividualRequest": { "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_models.CreateIndividualRequest" } } } }, "customers-api_internal_services_customers_bulk.ResponseWithResults": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_services_customers_bulk.Result" } } } }, "customers-api_internal_services_customers_bulk.Result": { "type": "object", "properties": { "message": { "type": "string", "example": "some error" }, "resourceID": { "description": "identifier of the REST-ful response", "type": "integer", "example": 2 }, "resultID": { "description": "identifier of the result item", "type": "integer", "example": 2 } } }, "customers-api_internal_services_customers_bulk.UpdateCompanyRequest": { "type": "object", "properties": { "requests": { "description": "products must contain IDs", "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_services_customers_bulk.UpdateCompanyRequestItem" } } } }, "customers-api_internal_services_customers_bulk.UpdateCompanyRequestItem": { "type": "object", "properties": { "GLN": { "description": "Global Location Number.", "type": "string" }, "bankAccountNumber": { "description": "Number of customer's bank account.", "type": "string" }, "bankIban": { "description": "IBAN number of customer's bank account.", "type": "string" }, "bankName": { "description": "Name of customer's bank.", "type": "string" }, "bankSwiftCode": { "description": "BIC/SWIFT identifier of customer's bank account.", "type": "string" }, "businessAreaId": { "description": "area of business.", "type": "integer" }, "code": { "description": "Registry code", "type": "string" }, "color": { "description": "Color that the customer entry is marked with. Possible values: \"\", \"yellow\", \"red\", \"blue\", \"green\".", "type": "string" }, "countryId": { "description": "Customer’s country.", "type": "integer" }, "creditLimit": { "description": "Customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe.", "type": "integer" }, "customerBalanceDisabled": { "description": "Flag indicating that Erply does not keep track of the customer's balance (amount prepaid or due)", "type": "boolean" }, "customerGroupId": { "type": "integer" }, "customerManagerId": { "description": "Customer manager (must be an employee", "type": "integer" }, "defaultPaymentDeadLine": { "description": "Default payment deadline (in days).", "type": "integer" }, "deliveryTypeId": { "description": "A field that propagates from customer records to sales documents and lets the company categorize shipments by delivery method or delivery time.", "type": "integer" }, "doNotSell": { "description": "Whether the customer is marked with a do not sell flag or not.", "type": "boolean" }, "eInvoiceEmail": { "description": "In UI, the field is titled “E-invoice email address”.", "type": "string" }, "eInvoiceReference": { "description": "Customer reference for e-invoices.", "type": "string" }, "eInvoicesViaEmailEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via electronic channels.", "type": "boolean" }, "ediCode": { "description": "E-invoice integration parameter.", "type": "string" }, "ediType": { "description": "EDI type. Possible values: 2DOC, 4DOC, SPECIAL.", "type": "string" }, "emailOptOut": { "description": "Flag indicating that this customer does not want to receive email correspondence.", "type": "boolean" }, "employeeId": { "description": "Employee ID of the employee changing this company customer.", "type": "integer" }, "facebookName": { "type": "string" }, "factoringContractNumber": { "description": "Factoring contract number.", "type": "string" }, "fax": { "type": "string" }, "gender": { "description": "Gender. Erply API only accepts \"male\" \"female\" or an empty string.", "type": "string" }, "homeStoreCustomId": { "description": "Additional, custom home store ID", "type": "integer" }, "homeStoreId": { "description": "Location where the customer shops most frequently. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "integrationCode": { "description": "Corresponding customer identifier in a system integrated with Erply (e.g. accounting software)", "type": "string" }, "invoicesViaDocuraEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via docura.", "type": "boolean" }, "invoicesViaEmailEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via email.", "type": "boolean" }, "isStarred": { "description": "Mark if a customer should be starred", "type": "boolean" }, "loyaltyCardNumber": { "description": "Assign the code of customer's loyalty/membership card. This code must match the sequence produced by card swipe.", "type": "string" }, "mail": { "type": "string" }, "mobile": { "type": "string" }, "name": { "description": "Name.", "type": "string" }, "notes": { "type": "string" }, "operatorId": { "description": "E-invoice integration parameter.", "type": "string" }, "paperMailsEnabled": { "description": "0 or 1: whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).", "type": "boolean" }, "partialTaxExemption": { "type": "boolean" }, "payerId": { "description": "“Payer of invoices” (another customer).", "type": "integer" }, "paysViaFactoring": { "description": "Flag indicating that this customer pays via factoring (all invoices must be addressed to a designated third party)", "type": "boolean" }, "penaltyForOverdue": { "description": "Late fee / penalty for overdue invoices.\nThe semantic meaning of this value is not strictly defined; usually we expect it to be “% per day”", "type": "number" }, "peppolId": { "description": "Peppol ID", "type": "string" }, "phone": { "type": "string" }, "posCouponsDisabled": { "description": "Flag indicating that coupons must not be automatically printed to this customer.", "type": "boolean" }, "preserveOldCardNumber": { "type": "boolean" }, "pricelistId": { "description": "Assign the customer a price list", "type": "integer" }, "pricelistId2": { "type": "integer" }, "pricelistId3": { "type": "integer" }, "pricelistId4": { "type": "integer" }, "pricelistId5": { "type": "integer" }, "primaryStoreId": { "description": "ID of the primary store", "type": "integer" }, "referenceNumber": { "description": "Customer’s reference number for sales invoices.\n\tAssign a reference number - if system is configured to use hand-created customer reference numbers.\n\tBy default, not necessary, since reference numbers are created automatically.", "type": "string" }, "resourceID": { "description": "The resourceId request field should be used for the product id in each request for the bulk update.", "type": "integer" }, "rewardPointsDisabled": { "description": "Flag indicating that the customer will not earn points for purchases. (They can still spend existing points though.)", "type": "boolean" }, "salesForCashOnly": { "description": "Flag “Sales for cash only”. By default, false", "type": "boolean" }, "secondaryStoreId": { "description": "ID of the secondary store", "type": "integer" }, "shipGoodsWithWaybills": { "description": "A flag indicating that this customer wants to get goods with Waybills, not Invoice-Waybills.", "type": "boolean" }, "signUpStoreId": { "description": "Location where the customer signed up. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "skype": { "type": "string" }, "taxExempt": { "description": "Flag indicating that this customer must not be charged sales tax.", "type": "boolean" }, "taxofficeId": { "description": "Feature used by Greek customers: office where the customer / supplier reports to. (This value must be shown on some printouts.)", "type": "integer" }, "twitterId": { "type": "string" }, "type": { "description": "Customer type. Possible values are \"DOMESTIC\", \"EU\", \"OUTSIDE_EU\".", "type": "string" }, "typeId": { "type": "integer" }, "vatNumber": { "description": "Customer's VAT number.", "type": "string" }, "webShopPassword": { "type": "string" }, "webShopUsername": { "description": "This is for web shop integrations: to store customers' web-shop login credentials in Erply.", "type": "string" }, "website": { "type": "string" } } }, "customers-api_internal_services_customers_bulk.UpdateIndividualRequest": { "type": "object", "properties": { "requests": { "description": "products must contain IDs", "type": "array", "items": { "$ref": "#/definitions/customers-api_internal_services_customers_bulk.UpdateIndividualRequestItem" } } } }, "customers-api_internal_services_customers_bulk.UpdateIndividualRequestItem": { "type": "object", "properties": { "GLN": { "description": "Global Location Number.", "type": "string" }, "bankAccountNumber": { "description": "Number of customer's bank account.", "type": "string" }, "bankIban": { "description": "IBAN number of customer's bank account.", "type": "string" }, "bankName": { "description": "Name of customer's bank.", "type": "string" }, "bankSwiftCode": { "description": "BIC/SWIFT identifier of customer's bank account.", "type": "string" }, "birthDate": { "description": "Date of birth (yyyy-mm-dd)", "type": "string" }, "businessAreaId": { "description": "area of business.", "type": "integer" }, "code": { "description": "National ID", "type": "string" }, "color": { "description": "Color that the customer entry is marked with. Possible values: \"\", \"yellow\", \"red\", \"blue\", \"green\".", "type": "string" }, "countryId": { "description": "Customer’s country.", "type": "integer" }, "creditLimit": { "description": "Customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe.", "type": "integer" }, "customerBalanceDisabled": { "description": "Flag indicating that Erply does not keep track of the customer's balance (amount prepaid or due)", "type": "boolean" }, "customerGroupId": { "type": "integer" }, "customerManagerId": { "description": "Customer manager (must be an employee", "type": "integer" }, "defaultPaymentDeadLine": { "description": "Default payment deadline (in days).", "type": "integer" }, "deliveryTypeId": { "description": "A field that propagates from customer records to sales documents and lets the company categorize shipments by delivery method or delivery time.", "type": "integer" }, "doNotSell": { "description": "Whether the customer is marked with a do not sell flag or not.", "type": "boolean" }, "eInvoiceEmail": { "description": "In UI, the field is titled “E-invoice email address”.", "type": "string" }, "eInvoiceReference": { "description": "Customer reference for e-invoices.", "type": "string" }, "eInvoicesViaEmailEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via electronic channels.", "type": "boolean" }, "ediCode": { "description": "E-invoice integration parameter.", "type": "string" }, "ediType": { "description": "EDI type. Possible values: 2DOC, 4DOC, SPECIAL.", "type": "string" }, "emailOptOut": { "description": "Flag indicating that this customer does not want to receive email correspondence.", "type": "boolean" }, "employeeId": { "description": "Employee ID of the employee changing this individual customer.", "type": "integer" }, "employerId": { "description": "Used to indicate that this person is a contact person / an employee in a particular company.", "type": "integer" }, "facebookName": { "type": "string" }, "factoringContractNumber": { "description": "Factoring contract number.", "type": "string" }, "fax": { "type": "string" }, "firstName": { "description": "First name / given name.", "type": "string" }, "gender": { "description": "Gender. Erply API only accepts \"male\" \"female\" or an empty string.", "type": "string" }, "homeStoreCustomId": { "description": "Additional, custom home store ID", "type": "integer" }, "homeStoreId": { "description": "Location where the customer shops most frequently. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "integrationCode": { "description": "Corresponding customer identifier in a system integrated with Erply (e.g. accounting software)", "type": "string" }, "invoicesViaDocuraEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via docura.", "type": "boolean" }, "invoicesViaEmailEnabled": { "description": "0 or 1: whether the customer wants to receive invoices via email.", "type": "boolean" }, "isStarred": { "description": "Mark if a customer should be starred", "type": "boolean" }, "jobTitleId": { "description": "Individual's job title Ids.", "type": "integer" }, "lastName": { "description": "Last name / family name.", "type": "string" }, "loyaltyCardNumber": { "description": "Assign the code of customer's loyalty/membership card. This code must match the sequence produced by card swipe.", "type": "string" }, "mail": { "type": "string" }, "mobile": { "type": "string" }, "notes": { "type": "string" }, "operatorId": { "description": "E-invoice integration parameter.", "type": "string" }, "paperMailsEnabled": { "description": "0 or 1: whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported).", "type": "boolean" }, "partialTaxExemption": { "type": "boolean" }, "payerId": { "description": "“Payer of invoices” (another customer).", "type": "integer" }, "paysViaFactoring": { "description": "Flag indicating that this customer pays via factoring (all invoices must be addressed to a designated third party)", "type": "boolean" }, "penaltyForOverdue": { "description": "Late fee / penalty for overdue invoices.\nThe semantic meaning of this value is not strictly defined; usually we expect it to be “% per day”", "type": "number" }, "peppolId": { "description": "Peppol ID", "type": "string" }, "phone": { "type": "string" }, "posCouponsDisabled": { "description": "Flag indicating that coupons must not be automatically printed to this customer.", "type": "boolean" }, "preserveOldCardNumber": { "type": "boolean" }, "priceListId": { "description": "Assign the customer a price list", "type": "integer" }, "priceListId2": { "type": "integer" }, "priceListId3": { "type": "integer" }, "priceListId4": { "type": "integer" }, "priceListId5": { "type": "integer" }, "primaryStoreId": { "description": "ID of the primary store", "type": "integer" }, "referenceNumber": { "description": "Customer’s reference number for sales invoices.\n\tAssign a reference number - if system is configured to use hand-created customer reference numbers.\n\tBy default,not necessary, since reference numbers are created automatically.", "type": "string" }, "resourceID": { "description": "The resourceId request field should be used for the product id in each request for the bulk update.", "type": "integer" }, "rewardPointsDisabled": { "description": "Flag indicating that the customer will not earn points for purchases. (They can still spend existing points though.)", "type": "boolean" }, "salesForCashOnly": { "description": "Flag “Sales for cash only”. By default,false", "type": "boolean" }, "secondaryStoreId": { "description": "ID of the secondary store", "type": "integer" }, "shipGoodsWithWaybills": { "description": "A flag indicating that this customer wants to get goods with Waybills, not Invoice-Waybills.", "type": "boolean" }, "signUpStoreId": { "description": "Location where the customer signed up. https://learn-api.erply.com/requests/getwarehouses", "type": "integer" }, "skype": { "type": "string" }, "taxExempt": { "description": "Flag indicating that this customer must not be charged sales tax.", "type": "boolean" }, "taxOfficeId": { "description": "Feature used by Greek customers: office where the customer / supplier reports to. (This value must be shown on some printouts.)", "type": "integer" }, "titleId": { "description": "A title (Mr / Mrs / Miss) etc.", "type": "integer" }, "twitterId": { "type": "string" }, "type": { "description": "Customer type. Possible values are \"DOMESTIC\", \"EU\", \"OUTSIDE_EU\".", "type": "string" }, "vatNumber": { "description": "Customer's VAT number.", "type": "string" }, "webShopPassword": { "type": "string" }, "webShopUsername": { "description": "This is for web shop integrations: to store customers' web-shop login credentials in Erply.", "type": "string" }, "website": { "type": "string" } } }, "customers-api_internal_services_shared_indentation.Result": { "type": "object", "properties": { "id": { "description": "ID of the element", "type": "integer", "example": 64 }, "name": { "description": "The name is the name in the client's default language. Will be prefixed n times if the element is a child of another element.", "type": "string", "example": "element 1" } } }, "models.Translatable": { "type": "object", "properties": { "ar": { "type": "string", "example": " " }, "cs": { "type": "string", "example": " " }, "da": { "type": "string", "example": " " }, "de": { "type": "string", "example": " " }, "el": { "type": "string", "example": " " }, "en": { "type": "string", "example": " " }, "es": { "type": "string", "example": " " }, "et": { "type": "string", "example": " " }, "fi": { "type": "string", "example": " " }, "fo": { "type": "string", "example": " " }, "fr": { "type": "string", "example": " " }, "he": { "type": "string", "example": " " }, "it": { "type": "string", "example": " " }, "lt": { "type": "string", "example": " " }, "lv": { "type": "string", "example": " " }, "nl": { "type": "string", "example": " " }, "no": { "type": "string", "example": " " }, "pl": { "type": "string", "example": " " }, "ru": { "type": "string", "example": " " }, "sv": { "type": "string", "example": " " }, "th": { "type": "string", "example": " " }, "tr": { "type": "string", "example": " " }, "vi": { "type": "string", "example": " " }, "zh_Hans": { "type": "string", "example": " " }, "zh_Hant": { "type": "string", "example": " " } } }, "responses.BulkResponse": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" } } } }, "responses.EmptyResponse": { "type": "object" }, "responses.MessageResponse": { "type": "object", "properties": { "message": { "type": "string", "example": "some error" } } }, "responses.Response": { "type": "object", "properties": { "id": { "type": "integer", "example": 73 } } } }, "securityDefinitions": { "cc": { "type": "apiKey", "name": "clientCode", "in": "header" }, "jwt": { "type": "apiKey", "name": "jwt", "in": "header" }, "sk": { "type": "apiKey", "name": "sessionKey", "in": "header" } }, "tags": [ { "name": "Customers" }, { "name": "Business Customers" }, { "name": "Individual Customers" }, { "name": "Addresses" }, { "description": "Attributes are attached to entities. The possible entities are: customer, customer group", "name": "Attributes" }, { "description": "Customer loyalty cards sometimes have an expiration date. When the card expires, a new card is issued to the customer, with a new number. Plastic cards get worn and need to be periodically replaced anyway, and they are often pre-produced in batches; a cashier cannot manufacture one on the spot, with the same number as the previous card. The old card, however, often remains in customer's possession (e.g. if the new one is mailed to them). Sometimes the customers mix them up, and bring their old card to the store. Therefore, it is pretty reasonable that the old card should keep identifying them as well.", "name": "Loyalty Cards" }, { "name": "Tags" }, { "name": "Tag Groups" } ] }