Портал для розробників-Counterparty-getCounterpartyOptions

Завантажити параметри Контрагента

Метод «getCounterpartyOptions», працює в моделі «Counterparty», цей метод використовується для отримання параметрів контрагента відправника в розрізі можливостей замовлення додаткових послуг, з розділу: «Формування запиту на створення ЕН із додатковими послугами» Замовити посслуги можливо через особистого менеджера.

Текст запиту

Параметр	Тип	Опис
Ref*	string[36]	Ідентифікатор (REF) контрагену

* Позначення обов’язкового параметру

                        
 
{
   "apiKey": "[ВАШ КЛЮЧ]",
   "modelName": "Counterparty",
   "calledMethod": "getCounterpartyOptions",
   "methodProperties": {"Ref" : "00000000-0000-0000-0000-000000000000"   }
}

                                  

    <?xml version="1.0" encoding="UTF-8"?>
            <file>
                <apiKey>[ВАШ КЛЮЧ]</apiKey>
                <modelName>Counterparty</modelName>
                <calledMethod>getCounterpartyOptions</calledMethod>
                <methodProperties>
                    <Ref>00000000-0000-0000-0000-000000000000</Ref>
                </methodProperties>
            </file>

Відповідь 200
Завжди повертає код 200 навіть при логічних помилках.

Тіло відповіді на запит

Параметр	Тип	Опис
AddressDocumentDelivery	bool	Адресна доставка документів
AfterpaymentType	bool	Тип для послуги Контроль оплати
BackwardDeliverySubtypesDocuments	bool	Зворотна доставка документів
BlockInternationalSenderLKK	bool	Міжнародна доставка
CalculationByFactualWeight	bool	Розрахунок по фактичній вазі
CanAfterpaymentOnGoodsCost	bool	Сплата коштів за товар (Контроль оплати)
CanCreditDocuments	bool	Оформлення кредиту
CanEWTransporter	bool	ParameterName
CanForwardingService	bool	Експедирування (Контроль поштучної передачі)
CanNonCashPayment	bool	Безготівковий розрахунок
CanPayTheThirdPerson	bool	Оплата третьею особою
CanSameDayDelivery	bool	Доставка день в день
CanSameDayDeliveryStandart	bool	Доставка день в день (локал-стандарт)
CanSentFromPostomat	bool	Відправка з поштомату
CanSignedDocuments	bool	Доступна послуга "Підпис документів"
CarCall	bool	Послуга виклик авто
CreditDocuments	bool	Зворотна доставка кредитних документів
CustomerReturn	bool	Послуга "Автоповернення відправлень"
DayCustomerReturn	bool	День автоповернення
DebtorParams	array	Дані заборгованності
DeliveryByHand	bool	Доставка в руки
DescentFromFloor	bool	Спуск з поверху
FillingWarranty	bool	Заповнення гарантійного талону
HaveMoneyWallets	bool	Електронний гаманець
HideDeliveryCost	bool	Приховати вартість доставки
InternationalDelivery	bool	Міжнародна доставка
InternationalDeliveryServiceType	bool	Тип міжнародної доставки
LoyaltyProgram	bool	Програма лояльності
MainCounterparty	bool	Головний контрагент
PickupService	bool	Можливість замовлення послуги Pick Up
PrintMarkingAllowedTypes	object	Тип доступного маркування
SecurePayment	bool	Надійна покупка
Services	bool	Послуги
ShowDeliveryByHand	bool	Доставка особисто в руки
SignedDocuments	bool	Зворотна доставка підписаних документів
TransferPricingConditions	bool	Умови трансфертного ціноутворення

                                  
{
  "success": true,
  "data": [{"AddressDocumentDelivery" : true,"AfterpaymentType" : true,"BackwardDeliverySubtypesDocuments" : true,"BlockInternationalSenderLKK" : true,"CalculationByFactualWeight" : true,"CanAfterpaymentOnGoodsCost" : true,"CanCreditDocuments" : true,"CanEWTransporter" : true,"CanForwardingService" : true,"CanNonCashPayment" : true,"CanPayTheThirdPerson" : true,"CanSameDayDelivery" : true,"CanSameDayDeliveryStandart" : true,"CanSentFromPostomat" : true,"CanSignedDocuments" : true,"CarCall" : true,"CreditDocuments" : true,"CustomerReturn" : true,"DayCustomerReturn" : true,"DebtorParams" : [{"AgreementId":"56897","PaymTermId":"2банківськідні","PastDueDebts":"0.00","BlockedStatus":"2"}],"DeliveryByHand" : true,"DescentFromFloor" : true,"FillingWarranty" : true,"HaveMoneyWallets" : true,"HideDeliveryCost" : true,"InternationalDelivery" : true,"InternationalDeliveryServiceType" : true,"LoyaltyProgram" : true,"MainCounterparty" : true,"PickupService" : true,"PrintMarkingAllowedTypes" : {"vbf":123},"SecurePayment" : true,"Services" : true,"ShowDeliveryByHand" : true,"SignedDocuments" : true,"TransferPricingConditions" : true  }],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

                                   
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <AddressDocumentDelivery>true</AddressDocumentDelivery>
        <AfterpaymentType>true</AfterpaymentType>
        <BackwardDeliverySubtypesDocuments>true</BackwardDeliverySubtypesDocuments>
        <BlockInternationalSenderLKK>true</BlockInternationalSenderLKK>
        <CalculationByFactualWeight>true</CalculationByFactualWeight>
        <CanAfterpaymentOnGoodsCost>true</CanAfterpaymentOnGoodsCost>
        <CanCreditDocuments>true</CanCreditDocuments>
        <CanEWTransporter>true</CanEWTransporter>
        <CanForwardingService>true</CanForwardingService>
        <CanNonCashPayment>true</CanNonCashPayment>
        <CanPayTheThirdPerson>true</CanPayTheThirdPerson>
        <CanSameDayDelivery>true</CanSameDayDelivery>
        <CanSameDayDeliveryStandart>true</CanSameDayDeliveryStandart>
        <CanSentFromPostomat>true</CanSentFromPostomat>
        <CanSignedDocuments>true</CanSignedDocuments>
        <CarCall>true</CarCall>
        <CreditDocuments>true</CreditDocuments>
        <CustomerReturn>true</CustomerReturn>
        <DayCustomerReturn>true</DayCustomerReturn>
        <DebtorParams>
             <item>
             <AgreementId>56897</AgreementId>
             <PaymTermId>2банківськідні</PaymTermId>
             <PastDueDebts>0.00</PastDueDebts>
             <BlockedStatus>2</BlockedStatus>
             </item>
        </DebtorParams>
        <DeliveryByHand>true</DeliveryByHand>
        <DescentFromFloor>true</DescentFromFloor>
        <FillingWarranty>true</FillingWarranty>
        <HaveMoneyWallets>true</HaveMoneyWallets>
        <HideDeliveryCost>true</HideDeliveryCost>
        <InternationalDelivery>true</InternationalDelivery>
        <InternationalDeliveryServiceType>true</InternationalDeliveryServiceType>
        <LoyaltyProgram>true</LoyaltyProgram>
        <MainCounterparty>true</MainCounterparty>
        <PickupService>true</PickupService>
        <PrintMarkingAllowedTypes>
             <vbf>123</vbf>
        </PrintMarkingAllowedTypes>
        <SecurePayment>true</SecurePayment>
        <Services>true</Services>
        <ShowDeliveryByHand>true</ShowDeliveryByHand>
        <SignedDocuments>true</SignedDocuments>
        <TransferPricingConditions>true</TransferPricingConditions>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Спробувати API

Завантажити параметри Контрагента

                                   
    <?xml version="1.0" encoding="UTF-8"?>
            <file>
                <apiKey>[ВАШ КЛЮЧ]</apiKey>
                <modelName>Counterparty</modelName>
                <calledMethod>getCounterpartyOptions</calledMethod>
                <methodProperties>
                    <Ref></Ref>
                </methodProperties>
            </file>