Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Контрагенти

Робота з даними контрагентів

🔗Початок роботи з API

Створити контрагента

Створити контрагента (JSON)

post

Метод save моделі CounterpartyGeneral (або Counterparty) використовується для створення контрагента-отримувача.

Особливості:

  • Дозволяє створювати контрагентів-отримувачів із типом «Приватна особа» (PrivatePerson).

  • Дані щодо отримувача вносяться лише українською мовою.

  • Рекомендовано проводити оновлення довідника один раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 302

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CounterpartyGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "FirstName": "Іван",
    "MiddleName": "Іванович",
    "LastName": "Іванов",
    "Phone": "380997979789",
    "Email": "test@i.com",
    "CounterpartyType": "PrivatePerson",
    "CounterpartyProperty": "Recipient"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Description": "Іванов Іван Іванович",
      "FirstName": "Іван",
      "MiddleName": "Іванович",
      "LastName": "Іванов",
      "Counterparty": "00000000-0000-0000-0000-000000000000",
      "OwnershipForm": "00000000-0000-0000-0000-000000000001",
      "OwnershipFormDescription": "Null",
      "EDRPOU": "Null",
      "CounterpartyType": "PrivatePerson",
      "ContactPerson": [
        {
          "success": true,
          "data": [
            {
              "Ref": "c80e9610-e98b-11ef-b619-005056bdc0e9",
              "Description": "Іванов Іван Іванович",
              "LastName": "Іванов",
              "FirstName": "Іван",
              "MiddleName": "Іванович"
            }
          ],
          "errors": [],
          "translatedErrors": [],
          "warnings": [],
          "info": [],
          "messageCodes": [],
          "errorCodes": [],
          "warningCodes": [],
          "infoCodes": []
        }
      ]
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Створити контрагента (XML)

post

Метод save моделі CounterpartyGeneral (або Counterparty) дозволяє створити контрагента-отримувача у форматі XML.

Особливості:

  • Дозволяє створювати контрагентів-отримувачів із типом «Приватна особа» (PrivatePerson).

  • Дані щодо отримувача вносяться лише українською мовою.

  • Рекомендовано проводити оновлення довідника один раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 570

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CounterpartyGeneral</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <FirstName>Іван</FirstName>
        <MiddleName>Іванович</MiddleName>
        <LastName>Іванов</LastName>
        <Phone>380997979789</Phone>
        <Email>test@i.com</Email>
        <CounterpartyType>PrivatePerson</CounterpartyType>
        <CounterpartyProperty>Recipient</CounterpartyProperty>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
            <Description>Іванов Іван Іванович</Description>
            <FirstName>Іван</FirstName>
            <MiddleName>Іванович</MiddleName>
            <LastName>Іванов</LastName>
            <Counterparty>00000000-0000-0000-0000-000000000000</Counterparty>
            <OwnershipForm>00000000-0000-0000-0000-000000000001</OwnershipForm>
            <OwnershipFormDescription>Null</OwnershipFormDescription>
            <EDRPOU>Null</EDRPOU>
            <CounterpartyType>PrivatePerson</CounterpartyType>
            <ContactPerson>
                <item>
                    <success>true</success>
                    <data>
                        <item>
                            <Ref>c80e9610-e98b-11ef-b619-005056bdc0e9</Ref>
                            <Description>Іванов Іван Іванович</Description>
                            <LastName>Іванов</LastName>
                            <FirstName>Іван</FirstName>
                            <MiddleName>Іванович</MiddleName>
                        </item>
                    </data>
                    <errors/>
                    <translatedErrors/>
                    <warnings/>
                    <info/>
                    <messageCodes/>
                    <errorCodes/>
                    <warningCodes/>
                    <infoCodes/>
                </item>
            </ContactPerson>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Створити контрагента «Третя особа» (JSON)

post

Метод save працює в моделі CounterpartyGeneral (або Counterparty) і використовується для створення контрагента-отримувача.

Додаткові особливості та правила

Метод дозволяє створювати контрагентів-отримувачів із типом «Третя особа». Контрагента-отримувача з типом «Приватна особа» можуть створювати клієнти, які підписали угоду з компанією «Нова пошта».

  • Дані щодо отримувача вносяться лише українською мовою.

  • Рекомендовано проводити оновлення довідника один раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CounterpartyGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: savePossible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 336

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CounterpartyGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "FirstName": "",
    "MiddleName": "",
    "LastName": "",
    "Phone": "380997979789",
    "Email": "test@i.com",
    "CounterpartyType": "Organization",
    "EDRPOU": "12345678",
    "CounterpartyProperty": "ThirdPerson",
    "CityRef": "00000000-0000-0000-0000-000000000000"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "FirstName": "",
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Description": "Назва організації",
      "OwnershipForm": "00000000-0000-0000-0000-000000000001",
      "OwnershipFormDescription": "ТОВ",
      "EDRPOU": "12345678",
      "CounterpartyType": "Organization",
      "LastName": "",
      "MiddleName": ""
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Створити контрагента «Третя особа» (XML)

post

Метод save працює в моделі CounterpartyGeneral (або Counterparty) і використовується для створення контрагента-отримувача.

Додаткові особливості та правила

Метод дозволяє створювати контрагентів-отримувачів із типом «Третя особа». Контрагента-отримувача з типом «Приватна особа» можуть створювати клієнти, які підписали угоду з компанією «Нова пошта».

  • Дані щодо отримувача вносяться лише українською мовою.

  • Рекомендовано проводити оновлення довідника один раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 635

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CounterpartyGeneral</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <FirstName></FirstName>
        <MiddleName></MiddleName>
        <LastName></LastName>
        <Phone>380997979789</Phone>
        <Email>test@i.com</Email>
        <CounterpartyType>Organization</CounterpartyType>
        <EDRPOU>12345678</EDRPOU>
        <CounterpartyProperty>ThirdPerson</CounterpartyProperty>
        <CityRef>00000000-0000-0000-0000-000000000000</CityRef>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <FirstName></FirstName>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <Description>Назва організації</Description>
        <OwnershipForm>00000000-0000-0000-0000-000000000001</OwnershipForm>
        <OwnershipFormDescription>ТОВ</OwnershipFormDescription>
        <EDRPOU>12345678</EDRPOU>
        <CounterpartyType>Organization</CounterpartyType>
        <LastName></LastName>
        <MiddleName></MiddleName>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Створити контрагента «Організація» (JSON)

post

Метод save працює в моделі CounterpartyGeneral (або Counterparty) і використовується для створення контрагента-отримувача.

Додаткові особливості та правила

Метод дозволяє створювати контрагентів-отримувачів із типом «Організація».

  • Дані щодо отримувача вносяться лише українською мовою.

  • Рекомендовано проводити оновлення довідника один раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CounterpartyGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: savePossible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 196

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CounterpartyGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "CounterpartyType": "Organization",
    "EDRPOU": "12345678",
    "CounterpartyProperty": "Recipient"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Description": "Назва організації",
      "FirstName": "Назва організації",
      "OwnershipForm": "00000000-0000-0000-0000-000000000001",
      "OwnershipFormDescription": "ФОП",
      "EDRPOU": "32145678",
      "CounterpartyType": "PrivatePerson"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Створити контрагента «Організація» (XML)

post

Метод save працює в моделі CounterpartyGeneral (або Counterparty) і використовується для створення контрагента-отримувача.

Додаткові особливості та правила

Метод дозволяє створювати контрагентів-отримувачів із типом «Організація».

  • Дані щодо отримувача вносяться лише українською мовою.

  • Рекомендовано проводити оновлення довідника один раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 397

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CounterpartyGeneral</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <CounterpartyType>Organization</CounterpartyType>
        <EDRPOU>12345678</EDRPOU>
        <CounterpartyProperty>Recipient</CounterpartyProperty>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <Description>Назва організації</Description>
        <FirstName>Назва організації</FirstName>
        <OwnershipForm>00000000-0000-0000-0000-000000000001</OwnershipForm>
        <OwnershipFormDescription>ФОП</OwnershipFormDescription>
        <EDRPOU>32145678</EDRPOU>
        <CounterpartyType>PrivatePerson</CounterpartyType>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Робота з даними контрагента

Оновити дані контрагента (JSON)

post

Метод update працює в моделі CounterpartyGeneral (або Counterparty) і використовується для оновлення/внесення змін у дані контрагента-отримувача.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CounterpartyGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: updatePossible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 398

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CounterpartyGeneral",
  "calledMethod": "update",
  "methodProperties": {
    "Ref": "00000000-0000-0000-0000-000000000000",
    "CityRef": "00000000-0000-0000-0000-000000000000",
    "FirstName": "Іван",
    "MiddleName": "Іванович",
    "LastName": "Іванов",
    "Phone": "380997979789",
    "Email": "test@i.com",
    "CounterpartyType": "PrivatePerson",
    "CounterpartyProperty": "Recipient"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Description": "Іванов Іван Іванович",
      "FirstName": "Іван",
      "MiddleName": "Іванович",
      "LastName": "Іванов",
      "Counterparty": "",
      "OwnershipForm": "00000000-0000-0000-0000-000000000000",
      "OwnershipFormDescription": "ФОП",
      "EDRPOU": "12345678",
      "CounterpartyType": "PrivatePerson",
      "ContactPerson": "Іванов Іван Іванович"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Оновити дані контрагента (XML)

post

Метод update працює в моделі CounterpartyGeneral (або Counterparty) і використовується для оновлення/внесення змін у дані контрагента-отримувача.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 694

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CounterpartyGeneral</modelName>
    <calledMethod>update</calledMethod>
    <methodProperties>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <CityRef>00000000-0000-0000-0000-000000000000</CityRef>
        <FirstName>Іван</FirstName>
        <MiddleName>Іванович</MiddleName>
        <LastName>Іванов</LastName>
        <Phone>380997979789</Phone>
        <Email>test@i.com</Email>
        <CounterpartyType>PrivatePerson</CounterpartyType>
        <CounterpartyProperty>Recipient</CounterpartyProperty>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <Description>Іванов Іван Іванович</Description>
        <FirstName>Іван</FirstName>
        <MiddleName>Іванович</MiddleName>
        <LastName>Іванов</LastName>
        <Counterparty></Counterparty>
        <OwnershipForm>00000000-0000-0000-0000-000000000000</OwnershipForm>
        <OwnershipFormDescription>ФОП</OwnershipFormDescription>
        <EDRPOU>12345678</EDRPOU>
        <CounterpartyType>PrivatePerson</CounterpartyType>
        <ContactPerson>Іванов Іван Іванович</ContactPerson>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Видалити контрагента-одержувача (JSON)

post

Метод delete працює в моделі CounterpartyGeneral (або Counterparty) і використовується для видалення контрагента-отримувача. Для видалення контрагента-відправника необхідно звертатися до вашого менеджера.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CounterpartyGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: deletePossible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 154

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

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Видалити контрагента-одержувача (XML)

post

Метод delete працює в моделі CounterpartyGeneral (або Counterparty) і використовується для видалення контрагента-отримувача. Для видалення контрагента-відправника необхідно звертатися до вашого менеджера.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 298

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

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Завантажити список адрес контрагентів (JSON)

post

Метод getCounterpartyAddresses працює в моделі CounterpartyGeneral (або Counterparty) і завантажує список контрагентів (відправників/отримувачів).

Додаткові особливості та правила

  • Необхідно зберігати копію довідника на стороні клієнта та підтримувати його в актуальному стані.

  • Рекомендовано проводити оновлення довідників раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CounterpartyGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getCounterpartyAddressesPossible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CounterpartyGeneral",
  "calledMethod": "getCounterpartyAddresses",
  "methodProperties": {
    "Ref": "00000000-0000-0000-0000-000000000000",
    "CounterpartyProperty": "Sender"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Description": "Хрещатик, 1"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Завантажити список адрес контрагентів (XML)

post

Метод getCounterpartyAddresses працює в моделі CounterpartyGeneral (або Counterparty) і завантажує список контрагентів (відправників/отримувачів).

Додаткові особливості та правила

  • Необхідно зберігати копію довідника на стороні клієнта та підтримувати його в актуальному стані.

  • Рекомендовано проводити оновлення довідників раз на місяць.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 377

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

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <Description>Хрещатик, 1</Description>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Завантажити параметри контрагента (JSON)

post

Метод getCounterpartyOptions працює в моделі Counterparty (або CounterpartyGeneral) і використовується для отримання параметрів контрагента-відправника для замовлення додаткових послуг (див. «Формування запиту на створення експрес-накладної із додатковими послугами», метод save моделі InternetDocument). Замовити послуги можна через особистого менеджера.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CounterpartyGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getCounterpartyOptionsPossible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 170

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

Успішна відповідь (JSON)

{
  "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)

post

Метод getCounterpartyOptions працює в моделі Counterparty (або СounterpartyGeneral) і використовується для отримання параметрів контрагента-відправника для замовлення додаткових послуг (див. «Формування запиту на створення експрес-накладної із додатковими послугами», метод save моделі InternetDocument). Замовити послуги можна через особистого менеджера.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 314

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

Успішна відповідь (XML)

<?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>

Завантажити список контактних осіб контрагента (JSON)

post

Метод getCounterpartyContactPersons працює в моделі Counterparty (або СounterpartyGeneral) і завантажує список контактних осіб контрагентів.

Додаткові особливості та правила

  • Якщо кількість контактних осіб перевищує 100, необхідно використовувати параметр Page.

  • Копію довідника необхідно зберігати на стороні клієнта та підтримувати його в актуальному стані.

  • Рекомендовано проводити оновлення довідників один раз на день.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CounterpartyGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getCounterpartyContactPersonsPossible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CounterpartyGeneral",
  "calledMethod": "getCounterpartyContactPersons",
  "methodProperties": {
    "Ref": "00000000-0000-0000-0000-000000000000",
    "Page": "1"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Description": "Іванов Іван Іванович",
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Phones": "380971155109",
      "Email": "test@i.com",
      "LastName": "Іванов",
      "FirstName": "Іван",
      "MiddleName": "Іванович"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Завантажити список контактних осіб контрагента (XML)

post

Метод getCounterpartyContactPersons працює в моделі Counterparty (або CounterpartyGeneral) і завантажує список контактних осіб контрагентів.

Додаткові особливості та правила

  • Якщо кількість контактних осіб перевищує 100, необхідно використовувати параметр Page.

  • Копію довідника необхідно зберігати на стороні клієнта та підтримувати його в актуальному стані.

  • Рекомендовано проводити оновлення довідників один раз на день.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 345

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

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Description>Іванов Іван Іванович</Description>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <Phones>380971155109</Phones>
        <Email>test@i.com</Email>
        <LastName>Іванов</LastName>
        <FirstName>Іван</FirstName>
        <MiddleName>Іванович</MiddleName>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Завантажити список контрагентів (JSON)

post

Метод getCounterparties працює в моделі Counterparty (або CounterpartyGeneral) і завантажує список контрагентів (відправників, отримувачів та третіх осіб).

Додаткові особливості та правила

  • Якщо кількість контрагентів перевищує 100, необхідно використовувати параметр Page.

  • Якщо до запиту додати параметр FindByString (пошук за рядком) і в його значенні вказати назву контрагента, якого потрібно знайти (наприклад, «Талісман»), буде виконано пошук у довіднику та повернено відповідного контрагента.

  • Копію довідника необхідно зберігати на стороні клієнта та підтримувати його в актуальному стані.

  • Рекомендовано проводити оновлення довідників раз на день.

Body
apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]
modelNamestring · enumRequired

Назва моделі API

Example: CounterpartyGeneralPossible values:
calledMethodstring · enumRequired

Назва методу API

Example: getCounterpartiesPossible values:
Responses
200

Успішна відповідь (JSON)

application/json
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "CounterpartyGeneral",
  "calledMethod": "getCounterparties",
  "methodProperties": {
    "CounterpartyProperty": "Sender",
    "Page": "1"
  }
}
200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Description": "Талісман ТОВ",
      "Ref": "00000000-0000-0000-0000-000000000000",
      "City": "00000000-0000-0000-0000-000000000000",
      "Counterparty": "null",
      "FirstName": "Іван",
      "LastName": "Іванов",
      "MiddleName": "Іванович",
      "OwnershipFormRef": "00000000-0000-0000-0000-000000000000",
      "OwnershipFormDescription": "ТОВ",
      "EDRPOU": "37193071",
      "CounterpartyType": "Organization"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Завантажити список контрагентів (XML)

post

Метод getCounterparties працює в моделі Counterparty (або CounterpartyGeneral) і завантажує список контрагентів (відправників, отримувачів та третіх осіб).

Додаткові особливості та правила

  • Якщо кількість контрагентів перевищує 100, необхідно використовувати параметр Page.

  • Якщо до запиту додати параметр FindByString (пошук за рядком) і в його значенні вказати назву контрагента, якого потрібно знайти (наприклад, «Талісман»), буде виконано пошук у довіднику та повернено відповідного контрагента.

  • Копію довідника необхідно зберігати на стороні клієнта та підтримувати його в актуальному стані.

  • Рекомендовано проводити оновлення довідників раз на день.

Body
apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:
calledMethodstring · enumRequired

Назва методу API

Possible values:
Responses
200

Успішна відповідь (XML)

application/xml
successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 337

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>CounterpartyGeneral</modelName>
    <calledMethod>getCounterparties</calledMethod>
    <methodProperties>
        <CounterpartyProperty>Sender</CounterpartyProperty>
        <Page>1</Page>
    </methodProperties>
</file>
"
200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <Description>Талісман ТОВ</Description>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <City>00000000-0000-0000-0000-000000000000</City>
        <Counterparty>null</Counterparty>
        <FirstName>Іван</FirstName>
        <LastName>Іванов</LastName>
        <MiddleName>Іванович</MiddleName>
        <OwnershipFormRef>00000000-0000-0000-0000-000000000000</OwnershipFormRef>
        <OwnershipFormDescription>ТОВ</OwnershipFormDescription>
        <EDRPOU>37193071</EDRPOU>
        <CounterpartyType>Organization</CounterpartyType>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Останнє оновлення