QUINCE API. Виплата зарплати

Список методів

Метод	Опис
`/api/v2/document/salary_payment/list`	Отримання списку документів виплати зарплати
`/api/v2/document/salary_payment/load`	Отримання одного документа з повними рядками
`/api/v2/document/salary_payment/add`	Додавання документа
`/api/v2/document/salary_payment/update`	Оновлення документа
`/api/v2/document/salary_payment/unpublish`	Зняття документа з проведення

Отримання списку документів

Назва методу: /api/v2/document/salary_payment/list

Повертає список документів виплати зарплати. Для навігації використовується номер сторінки page.

Параметри запиту

Поле	Опис
`filter.Id`	Ідентифікатор документа.
`filter.DateFrom`	Початок періоду у форматі `YYYY-MM-DD` або `YYYY-MM-DD HH:mm:ss`.
`filter.DateTo`	Кінець періоду у форматі `YYYY-MM-DD` або `YYYY-MM-DD HH:mm:ss`.
`filter.Company`	Ідентифікатор організації.
`filter.Archive`	Ознака архівності.
`filter.MobileApp`	Якщо `true`, API повертає збільшений ліміт елементів для мобільного сценарію.
`page`	Номер сторінки. Необов’язковий.

Якщо DateFrom і DateTo не передані та немає фільтра Id, API повертає документи за поточний день. Якщо передати тільки одну з дат, API поверне помилку DateFrom and DateTo are required. Дати без часу автоматично розширюються до початку та кінця дня.

Основні поля відповіді

Поле	Опис
`Id`	Ідентифікатор документа.
`Date`	Дата документа у часовому поясі користувача.
`Number`	Номер документа.
`Fixed`	Ознака проведення документа.
`Void`	Ознака архівності.
`CompanyId`, `CompanyName`	Організація.
`CashAccountId`, `CashAccountName`	Каса або грошовий рахунок виплати.
`CashFlowItemId`, `CashFlowItemName`	Стаття руху коштів.
`ResponsibleId`, `ResponsibleName`	Відповідальний.
`DepartmentId`, `DepartmentName`	Підрозділ документа.
`Sum`	Сума до виплати.
`MainSum`	Основна сума документа.
`SalaryPeriod`	Період зарплати.
`Comment`	Коментар.
`CurrencyCode`	Код валюти рахунку.
`RowsSalary`	Зарплатні рядки документа.

Поля рядків у відповіді списку

Поле	Опис
`RowsSalary[].Id`	Ідентифікатор рядка.
`RowsSalary[].RowNo`	Номер рядка.
`RowsSalary[].CompanyPersonId`, `RowsSalary[].PersonName`	Співробітник.
`RowsSalary[].SalaryMoveItemId`, `RowsSalary[].SalaryItemName`	Стаття нарахування або виплати.
`RowsSalary[].DepartmentId`, `RowsSalary[].DepartmentName`	Підрозділ рядка.
`RowsSalary[].SegmentId`, `RowsSalary[].SegmentName`	Сегмент.
`RowsSalary[].ProjectId`, `RowsSalary[].ProjectName`	Проєкт.
`RowsSalary[].UnitId`, `RowsSalary[].UnitName`	Одиниця виміру.
`RowsSalary[].Qty`	Кількість.
`RowsSalary[].Tariff`	Тариф.
`RowsSalary[].CashAccountSum`	Сума до виплати по рядку.
`RowsSalary[].MSum`	Основна сума по рядку.
`RowsSalary[].CashAccountSumComission`	Комісія по рядку.
`RowsSalary[].CalculationBase`	База розрахунку.
`RowsSalary[].Percent`	Відсоток.
`RowsSalary[].CommentRow`	Коментар до рядка.

Приклад запиту

{
  "filter": {
    "DateFrom": "2026-06-01",
    "DateTo": "2026-06-30",
    "Company": 126
  },
  "page": 1
}

Отримання одного документа

Назва методу: /api/v2/document/salary_payment/load

Повертає один документ виплати зарплати разом із повним набором зарплатних рядків.

Параметри запиту

Поле	Опис
`Id`	Ідентифікатор документа. Обов’язковий.

Приклад запиту

{
  "Id": 8452
}

load повертає ту саму шапку документа, що і list, але зручний для сценаріїв детального перегляду або редагування одного документа.

Додавання документа

Назва методу: /api/v2/document/salary_payment/add

Метод додає один документ за запит. Якщо передати Fixed: true, API спробує провести документ після створення.

Поле	Опис
`array`	Масив з одним документом.
`array[].Date`	Дата документа. Обов’язкова.
`array[].Company`	Id організації. Обов’язковий.
`array[].CashAccount`	Id каси або рахунку виплати. Обов’язковий.
`array[].CashFlowItem`	Id статті руху коштів.
`array[].Responsible`	Id відповідального. Обов’язковий.
`array[].Department`	Id підрозділу документа.
`array[].Segment`	Id сегмента документа.
`array[].Project`	Id проєкту документа.
`array[].SalaryPeriod`	Період зарплати. Обов’язковий.
`array[].Comment`	Коментар.
`array[].Fixed`	Провести документ після створення.
`array[].RowsSalary`	Масив зарплатних рядків. Обов’язковий.

Поля рядків збереження

Поле	Опис
`RowsSalary[].CompanyPerson`	Id співробітника. Обов’язковий.
`RowsSalary[].SalaryMoveItem`	Id статті зарплати. Обов’язковий.
`RowsSalary[].Department`	Id підрозділу рядка.
`RowsSalary[].Segment`	Id сегмента рядка.
`RowsSalary[].Project`	Id проєкту рядка.
`RowsSalary[].Unit`	Id одиниці виміру.
`RowsSalary[].Qty`	Кількість.
`RowsSalary[].Tariff`	Тариф.
`RowsSalary[].MSum` або `RowsSalary[].Sum`	Основна сума рядка.
`RowsSalary[].CashAccountSum`	Сума до виплати. Якщо не передати, API візьме `MSum`.
`RowsSalary[].CashAccountSumComission`	Комісія по рядку.
`RowsSalary[].CalculationBase`	База розрахунку.
`RowsSalary[].Percent`	Відсоток.
`RowsSalary[].CommentRow`	Коментар до рядка.

Якщо Sum і MainSum у шапці не передані, API автоматично порахує їх із RowsSalary: Sum з CashAccountSum, а MainSum з MSum.

Приклад створення

{
  "array": [
    {
      "Date": "2026-06-16",
      "Company": 126,
      "CashAccount": 110,
      "CashFlowItem": 100,
      "Responsible": 57,
      "Department": 12,
      "SalaryPeriod": "2026-06-01",
      "Comment": "Виплата зарплати за першу половину червня",
      "Fixed": true,
      "RowsSalary": [
        {
          "CompanyPerson": 301,
          "SalaryMoveItem": 12,
          "Department": 12,
          "Project": 44,
          "Qty": 1,
          "Tariff": 18000,
          "MSum": 9000,
          "CashAccountSum": 8850,
          "CashAccountSumComission": 150,
          "CalculationBase": 1,
          "Percent": 50,
          "CommentRow": "Аванс"
        }
      ]
    }
  ]
}

Оновлення документа

Назва методу: /api/v2/document/salary_payment/update

Метод оновлює один документ за запит. Поле Id обов’язкове.

Якщо RowsSalary не передано, API збереже поточні рядки документа. Якщо RowsSalary передано, API збереже переданий набір рядків.

Приклад оновлення

{
  "array": [
    {
      "Id": 8452,
      "Comment": "Уточнена виплата зарплати за першу половину червня",
      "Fixed": true,
      "RowsSalary": [
        {
          "Id": 12011,
          "CompanyPerson": 301,
          "SalaryMoveItem": 12,
          "Department": 12,
          "Project": 44,
          "Qty": 1,
          "Tariff": 18000,
          "MSum": 9200,
          "CashAccountSum": 9050,
          "CashAccountSumComission": 150,
          "CalculationBase": 1,
          "Percent": 50,
          "CommentRow": "Аванс після коригування"
        }
      ]
    }
  ]
}

Зняття документа з проведення

Назва методу: /api/v2/document/salary_payment/unpublish

Метод знімає з проведення один документ за запит.

{
  "array": [
    {
      "Id": 8452
    }
  ]
}