Skip to content

Income ​

INFO

Har bir javob umumiy konvertda qaytadi — code, message, messages, status_code, time — foydali yuk esa data ichida. Quyidagi jadvallar faqat data ichini tavsiflaydi.

POST /income/create ​

This method allows adding income into the account.

So‘rov tanasi

MaydonTurMajburiyTavsif
codestringYo‘q
organization_idstringHa
responsible_idstringHa
datestring (date-time)Ha
supplier_idstringHa
supplier_assistant_idstringYo‘q
warehouse_idstringHa
currency_idstringHa
notestringYo‘q
purchasesobject[]Ha
purchases[].purchase_idstringHa
purchases[].productsobject[]Ha
purchases[].products[].purchase_item_idstringHa
purchases[].products[].amountnumberHaStandart: 0
purchases[].products[].box_countnumberYo‘qStandart: 0
purchases[].products[].box_itemnumberYo‘qStandart: 0
purchases[].products[].product_idstringHa
purchases[].products[].costnumberHaStandart: 0
purchases[].products[].extra_costnumberHaStandart: 0
purchases[].products[].marksstring[]Ha
purchases[].products[].extra_costsobject[]Ha
additional_costsobject[]Yo‘q
additional_costs[].cost_idstringHa
additional_costs[].amountnumberHaStandart: 0
additional_costs[].customer_idstringYo‘q
additional_costs[].person_idstringYo‘q
additional_costs[].supplier_idstringYo‘q
additional_costs[].employee_idstringYo‘q
json
{
  "code": "INC-2024-001",
  "organization_id": "64b7f4d9e2b3b6a0b7c5d7f2",
  "responsible_id": "64b7f4d9e2b3b6a0b7c5d7f3",
  "date": "2024-07-20T10:30:00Z",
  "supplier_id": "64b7f4d9e2b3b6a0b7c5d7f4",
  "supplier_assistant_id": "64b7f4d9e2b3b6a0b7c5d7f5",
  "warehouse_id": "64b7f4d9e2b3b6a0b7c5d7f6",
  "currency_id": "64b7f4d9e2b3b6a0b7c5d7f7",
  "note": "Some notes about the income",
  "purchases": [
    {
      "purchase_id": "64b7f4d9e2b3b6a0b7c5d7f8",
      "products": []
    }
  ],
  "additional_costs": [
    {
      "cost_id": "64b7f4d9e2b3b6a0b7c5d7fc",
      "amount": 0,
      "customer_id": "64b7f4d9e2b3b6a0b7c5d7fd",
      "person_id": "64b7f4d9e2b3b6a0b7c5d7fe",
      "supplier_id": "64b7f4d9e2b3b6a0b7c5d7ff",
      "employee_id": "64b7f4d9e2b3b6a0b7c5d800"
    }
  ]
}

Javob

MaydonTurTavsif
created_atstring (date-time)
updated_atnumber (date-time)
codestring
numberstring
organization_idstring
organizationobject
organization._idstring
organization.namestring
datestring (date-time)
warehouse_idstring
warehouseobject
warehouse._idstring
warehouse.namestring
responsible_idstring
responsibleobject
responsible._idstring
responsible.full_namestring
supplier_idstring
supplierobject
supplier._idstring
supplier.namestring
currency_idstring
currencyobject
currency._idstring
currency.namestring
currency.symbolstring
currency.uuidnumber
currency.valuenumber
currency.sidestring
notestring
total_amountnumber
total_costnumber
additional_costsobject[]
additional_costs[].cost_idstring
additional_costs[].amountnumber
additional_costs[].costobject
additional_costs[].cost.namestring
additional_costs[].cost.is_affect_priceboolean
additional_costs[].cost.distribution_methodstring
additional_costs[].cost.recommended_amountnumber
additional_costs[].cost.max_amountnumber
additional_costs[].cost.currency_idstring
purchasesobject[]
statestring
created_byobject
created_by._idnumber
created_by.full_namestring
created_by.phone_numberstring
json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "created_at": "2025-05-01T12:00:00Z",
    "updated_at": 0,
    "code": "INC-2024-001",
    "number": "string",
    "organization_id": "string",
    "organization": {
      "_id": "string",
      "name": "string"
    },
    "date": "2025-05-01T12:00:00Z",
    "warehouse_id": "string",
    "warehouse": {
      "_id": "string",
      "name": "string"
    },
    "responsible_id": "string",
    "responsible": {
      "_id": "string",
      "full_name": "string"
    },
    "supplier_id": "string",
    "supplier": {
      "_id": "string",
      "name": "string"
    },
    "currency_id": "string",
    "currency": {
      "_id": "string",
      "name": "string",
      "symbol": "string",
      "uuid": 0,
      "value": 0,
      "side": "string"
    },
    "note": "string",
    "total_amount": 0,
    "total_cost": 0,
    "additional_costs": [
      {
        "cost_id": "string",
        "amount": 0,
        "cost": {
          "name": null,
          "is_affect_price": null,
          "distribution_method": null,
          "recommended_amount": null,
          "max_amount": null,
          "currency_id": null
        }
      }
    ],
    "purchases": [
      {}
    ],
    "state": "string",
    "created_by": {
      "_id": 0,
      "full_name": "string",
      "phone_number": "string"
    }
  },
  "time": "2025-05-01T12:00:00Z"
}

PUT /income/cancel ​

Cancel income

So‘rov tanasi

MaydonTurMajburiyTavsif
_idstringHa
cancel_extra_costbooleanHa
with_transactionsbooleanHa
json
{
  "_id": "64b7f4d9e2b3b6a0b7c5d801",
  "cancel_extra_cost": true,
  "with_transactions": true
}

Javob

Javob tuzilishi quyidagi bilan bir xil: POST /income/create.

GET /income/get-by-id/{id} ​

Get income using its _id

Yo‘l parametrlari

ParametrTurMajburiyTavsif
idstringHa

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

Javob tuzilishi quyidagi bilan bir xil: POST /income/create.

POST /income/get-paging ​

Get income by paging

So‘rov tanasi

MaydonTurMajburiyTavsif
pagenumberHaStandart: 1
limitnumberHaStandart: 20
searchstringYo‘q
supplier_idstringYo‘q
organization_idstringYo‘q
responsible_idstringYo‘q
date_fromstring (date-time)Yo‘q
date_tostring (date-time)Yo‘q
updated_atstring (date-time)Yo‘q
json
{
  "page": 1,
  "limit": 20,
  "search": "string",
  "supplier_id": "64b7f4d9e2b3b6a0b7c5d7ff",
  "organization_id": "64b7f4d9e2b3b6a0b7c5d800",
  "responsible_id": "64b7f4d9e2b3b6a0b7c5d801",
  "date_from": "2024-07-01T00:00:00Z",
  "date_to": "2024-07-31T23:59:59Z",
  "updated_at": "2024-07-20T10:30:00Z"
}

Javob

data.total — jami yozuvlar soni, data.data[] — joriy sahifadagi yozuvlar. Quyidagi jadval bitta yozuvni tavsiflaydi.

MaydonTurTavsif
created_atstring (date-time)
updated_atnumber (date-time)
codestring
numberstring
organization_idstring
organizationobject
organization._idstring
organization.namestring
datestring (date-time)
responsible_idstring
responsibleobject
responsible._idstring
responsible.full_namestring
supplier_idstring
supplierobject
supplier._idstring
supplier.namestring
currency_idstring
currencyobject
currency._idstring
currency.namestring
currency.symbolstring
currency.uuidnumber
currency.valuenumber
currency.sidestring
notestring
total_amountnumber
total_costnumber
statestring
json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "total": 0,
    "data": [
      {
        "created_at": "2025-05-01T12:00:00Z",
        "updated_at": 0,
        "code": "INC-2024-001",
        "number": "string",
        "organization_id": "string",
        "organization": {
          "_id": "string",
          "name": "string"
        },
        "date": "2025-05-01T12:00:00Z",
        "responsible_id": "string",
        "responsible": {
          "_id": "string",
          "full_name": "string"
        },
        "supplier_id": "string",
        "supplier": {
          "_id": "string",
          "name": "string"
        },
        "currency_id": "string",
        "currency": {
          "_id": "string",
          "name": "string",
          "symbol": "string",
          "uuid": 0,
          "value": 0,
          "side": "string"
        },
        "note": "string",
        "total_amount": 0,
        "total_cost": 0,
        "state": "string"
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

Bu sahifa OpenAPI spetsifikatsiyasidan yaratilgan.

Bito 2.0 Integration API