Get several companies
Returns the companies listed in `companyIds`, each shaped by the `details` sub-queries. Prefer this over looping `GET {companyId}` when you already know the whole set of ids. Requires `Permissions.Companies.View`.
BearerAuthorizationBearer <token>OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.
companyIds?array<>details?array<>|nullapplication/json- response
[index: integer]?curl -X GET 'https://<your-instance>/api/companies/company-details' \ -H 'Authorization: Bearer <access-token>'[ { "account": "string", "address1": "string", "address2": "string", "address3": "string", "alias": "string", "allocatedVolumeOfReceivables": 0, "allowOnlyItemsFromCustomerPriceList": true, "automaticOrder": true, "availableVolumeOfReceivables": 0, "bank": "string", "bankCode": "stri", "bankConnectionCode": 0, "bankConstantSymbol": "string", "bankSpecificSymbol": "string", "birthCertificateNumber": "string", "brokerId": 0, "businessRegister": "string", "businessSalesCenter": "string", "changeOriginId": 0, "citizenship": "string", "city": "string", "claims": 0, "communicationLanguage": "string", "companyCreationDate": "2019-08-24T14:15:22Z", "companyIdentificationNumber": "string", "companyTypeId": 0, "connectedUserId": 0, "contactAddressAddress1": "string", "contactAddressAddress2": "string", "contactAddressAddress3": "string", "contactAddressCity": "string", "contactAddressCountry": "string", "contactAddressEmail": "string", "contactAddressFax": "string", "contactAddressIcq": "string", "contactAddressPhone": "string", "contactAddressWebsiteUrl": "string", "contactAddressZipCode": "string", "contactUserId": 0, "country": "string", "countryId": 0, "createdAt": "2019-08-24T14:15:22Z", "createdAtBranch": "string", "credit": 0, "creditBalance": 0, "creditDrawing": 0, "creditPaymentDiscountPercent": 0, "creditWorthinessId": 0, "currencyId": 0, "currentTurnover": 0, "customerAuthorizedPersonId": 0, "customerId": "string", "customerPriceListId": 0, "customerSalesCenter": "string", "dateOfBirth": "2019-08-24T14:15:22Z", "dateOfLastAresControl": "2019-08-24T14:15:22Z", "dateOfLastPurchase": "2019-08-24T14:15:22Z", "defaultCurrencyId": 0, "defaultWarehouseId": 0, "deliveryDays": 0, "directionOfDeliveryId": 0, "discount": 0, "discountDrawing": 0, "discountGroupDeliveryRouteId": 0, "discountGroupId": 0, "discountLimit": 0, "districtId": 0, "dueDate": 0, "dueDateCode": "st", "ediGln": "string", "ediGlnBranch": "string", "ediNorm": "string", "ediPairing": 0, "ekokomTypeId": 0, "emailReminderEmailAddress": "string", "eshopCustomerId": "string", "eshopLogin": "string", "eshopPassword": "string", "feedLink": "string", "feedPassword": "string", "feedPath": "string", "feedType": 0, "foreignCurrencyId": 0, "formForCreditNote": "string", "formForDeliveryNote": "string", "formForForeignInvoice": "string", "formForGoodsIssue": "string", "formForInvoice": "string", "frameworkOrder": "string", "gdprValidConsent": true, "guid": "string", "homelandAbroadOwn": 0, "ibanCode": "string", "id": 0, "identifyCustomerWhenUsingCustomerCard": true, "identityCardIssuanceDate": "2019-08-24T14:15:22Z", "identityCardIssuancePlace": "string", "identityCardNumber": "string", "incompleteData": true, "incotermsCodeId": 0, "incotermsText": "string", "initialTurnover": 0, "intrastatCountryOfOriginId": 0, "intrastatMovementCodeId": 0, "intrastatSenderCountryId": 0, "intrastatTermsOfDeliveryId": 0, "intrastatTransactionId": 0, "intrastatTransportTypeId": 0, "invoicingAddress1": "string", "invoicingAddress2": "string", "invoicingAddress3": "string", "invoicingCity": "string", "invoicingCountry": "string", "invoicingName": "string", "invoicingZipCode": "string", "isCustomsWarehouse": true, "isDeliveryNoteOnPOSDisabled": true, "isDiscountGroupFixed": true, "isEmailReminderEnabled": 0, "isInDecline": true, "isInInsolvency": true, "isInactive": true, "isInvoicingDisabled": true, "isNaturalPerson": true, "isPaymentOnCreditDisabled": true, "isSignotecSignatureDeliveryNoteEnabled": true, "isSmsReminderEnabled": 0, "isSummaryBillingEnabled": true, "isTaxWarehouse": true, "kindOfOperationId": 0, "labelId": 0, "lastLoginDate": "2019-08-24T14:15:22Z", "lastModify": "2019-08-24T14:15:22Z", "maximumDelayOfMaturity": 0, "minimalOrderAmount": 0, "name": "string", "nameAbbreviated": "string", "nameValidOnlyTillLogout": true, "nameWithoutDiacritics": "string", "note": "string", "noteForPrinting1": 0, "noteForPrinting2": 0, "noteForPrinting3": 0, "noteForPrinting4": 0, "noteForPrinting5": 0, "number": "string", "optional1Id": 0, "optional2Id": 0, "optional3Id": 0, "overdueReceivables": 0, "packagingLabelId": 0, "payToBankAccountNumber": "string", "paymentTypeId": 0, "photo": "string", "placeOfBirth": "string", "priceId": 0, "primaryContactEmail": "string", "primaryContactFax": "string", "primaryContactFunctionId": 0, "primaryContactIcq": "string", "primaryContactMobilePhone": "string", "primaryContactName": "string", "primaryContactPhone": "string", "primaryContactShouldSendMailTo": true, "primaryContactSmsEnabled": true, "primaryContactSurname": "string", "primaryContactTitle": "string", "priorityOfCoveringSalesOrder": 0, "purchaseContractNumber": "string", "regionId": 0, "routeId": 0, "routeOrder": 0, "sapCustomerNumber": "string", "sellerId": 0, "serviceDescription": "string", "sex": 0, "shippingTerminalOrder": 0, "shouldContactCustomerCenter": true, "showOnPackingTerminal": true, "showOnShippingTerminal": true, "smsReminderPhoneNumber": "string", "specializationId": 0, "surcharge": 0, "swiftCode": "string", "totalPoints": 0, "transportDriverId": 0, "transportTypeId": 0, "typeOfCreditAutomaticRenewal": 0, "typeOfDiscountAutomaticRenewal": 0, "userId": 0, "usesSSCC": true, "vatCode": "strin", "vatIdentificationNumber": "string", "vatPayer": true, "vatRegistrationNumber": "string", "websiteUrl": "string", "zipCode": "string", "authorizedPersons": [ { "companyId": 0, "email": "string", "id": 0, "isInactive": true, "name": "string", "number": "string", "phone": "string", "shouldSendMailTo": true } ], "branches": [ { "address1": "string", "address2": "string", "address3": "string", "barcode": "string", "branchCreationDate": "2019-08-24T14:15:22Z", "city": "string", "companyId": 0, "companyIdentificationNumber": "string", "country": "string", "countryId": 0, "customerId": 0, "deliveryDays": 0, "districtId": 0, "email1": "string", "email2": "string", "email3": "string", "email4": "string", "frameworkOrder": "string", "gps": "string", "homelandAbroadOwn": 0, "id": 0, "isB2BEnabled": true, "isInactive": true, "linkB2BWarehouseId": 0, "linkUserId": 0, "linkWarehouseId": 0, "name": "string", "note": "string", "number": "string", "paymentTypeId": 0, "person1": "string", "person2": "string", "person3": "string", "person4": "string", "phone1": "string", "phone2": "string", "phone3": "string", "phone4": "string", "regionId": 0, "routeId": 0, "routeOrder": 0, "salesRepresentativeId": 0, "storeChainName": "string", "transportTypeId": 0, "vatCode": "strin", "vatRegistrationNumber": "string", "visitFrequency": "string", "zipCode": "string" } ], "cards": [ { "barcode": "string", "companyId": 0, "discount": 0, "discountAmount": 0, "discountGroupId": 0, "guid": "string", "id": 0, "isBillingEnabled": true, "isInvalid": true, "lastModify": "2019-08-24T14:15:22Z", "name": "string", "note": "string", "validFrom": "2019-08-24T14:15:22Z", "validTo": "2019-08-24T14:15:22Z" } ], "representatives": [ { "address1": "string", "address2": "string", "city": "string", "companyId": 0, "country": "string", "dateOfBirth": "2019-08-24T14:15:22Z", "dateOfNameDay": "2019-08-24T14:15:22Z", "email": "string", "eshopRepresentativeId": "string", "fax": "string", "functionId": 0, "id": 0, "isInformEnabled": true, "mobilePhone": "string", "name": "string", "note": "string", "phone": "string", "surname": "string", "title": "string", "zipCode": "string" } ], "types": [ "wholeSaleCustomer" ] }]Create a company POST
Creates a company together with the child collections present in the body and returns it (201, `Location` header set). Requires `Permissions.Companies.Create`.
Search companies POST
Returns one page of companies matching the filter. Companies cover customers and suppliers alike; which one a row is depends on its flags. Body is a `PaginationRequest` — see the *Filtering & pagination* concept in the developer docs. Sortable and limitable fields depend on the instance's data-grid view. Requires `Permissions.Companies.Search`.