Нэхэмжлэх

Мөнгөн дүнгээр төлбөрийн нэхэмжлэх үүсгэх боломжтой бөгөөд дахин давташгүй веб хаяг url буцах болно. Та энэ хаягыг ашиглан харилцагчаа төлбөрийн буланд чиглүүлэх боломжтой юм.

Хэрэв та webhook тохиргоо хийсэн бол нэхэмжлэх төлөгдсөн талаарх мэдэгдэлийг цаг алдалгүй өөрийн системд хүлээн авах боломжтой юм.

Нэхэмжлэх обьект

Параметер	Төрөл	Тайлбар
status	String	Төлөв: draft, open, paid, void
amount	Number	Мөнгөн дүн.
description	String	Тайлбар.
auto_advance	Boolean	Автоматаар эцэслэх.
number	String	Дахин давтагдашгүй нэхэмжлэхийн дугаар.
project_id	String	Byl төслийн ID.
due_due	Date	Төлвөл зохих эцсийн хугацаа.
created_at	Date	Анх үүссэн огноо.
updated_at	Date	Өөрчлөлт орсон огноо.
id	Number	Нэхэмжлэхийн ID.
url	Number	Нэхэмжлэхийн веб хуудас.

Нэхэмжлэх үүсгэх

• HTTP Method: POST
• Content Type: application/json
• URL: https://byl.mn/api/v1/projects/1/invoices

Параметер

Параметер	Төрөл	Заавал эсэх	Тайлбар
amount	Number	true	Мөнгөн дүн.
description	String	false	Тайлбар.
auto_advance	Boolean	false	Автоматаар эцэслэх.

Жишээ хүсэлт

BYL_PROJECT_ID="таны төслийн ID"
BYL_TOKEN="таны API token"
$ curl -X POST https://byl.mn/api/v1/projects/$BYL_PROJECT_ID/invoices \
    -H "Authorization: Bearer $BYL_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'
    -D '{ "amount": 500, "description": "Test invoice", "auto_advance": true }'

Жишээ гаралт

{
  "data": {
    "status": "open",
    "amount": 10,
    "description": "Test invoice",
    "number": "DEMO-0011",
    "project_id": 1,
    "due_date": "2023-08-06T13:13:07.000000Z",
    "updated_at": "2023-08-05T13:13:07.000000Z",
    "created_at": "2023-08-05T13:13:07.000000Z",
    "id": 5708,
    "url": "https://byl.mn/h/invoice/5708/XN3GbRBxTslkMCeDj10CJtqlHiPfcmZ8"
  }
}

Нэхэмжлэх лавлах

• HTTP Method: GET
• Content Type: application/json
• URL: https://byl.mn/api/v1/projects/1/invoices/2

Жишээ хүсэлт

BYL_PROJECT_ID="таны төслийн ID"
BYL_TOKEN="таны API token"
$ curl -X GET https://byl.mn/api/v1/projects/$BYL_PROJECT_ID/invoices/5708 \
    -H "Authorization: Bearer $BYL_TOKEN" \
    -H 'Accept: application/json'

Жишээ гаралт

{
  "data": {
    "status": "open",
    "amount": 10,
    "description": "Test invoice",
    "number": "DEMO-0011",
    "project_id": 1,
    "due_date": "2023-08-06T13:13:07.000000Z",
    "updated_at": "2023-08-05T13:13:07.000000Z",
    "created_at": "2023-08-05T13:13:07.000000Z",
    "id": 5708,
    "url": "https://byl.mn/h/invoice/5708/XN3GbRBxTslkMCeDj10CJtqlHiPfcmZ8"
  }
}

Нэхэмжлэх хүчингүй болгох

Төлбөр төлөгдөөгүй нэхэмжлэхийг хүчингүй болгох боломжтой. Нэхэмжлэхийг хүчингүй болгосоноор төлбөр хүлээн авах боломжгүй болно.

• HTTP Method: POST
• Content Type: application/json
• URL: https://byl.mn/api/v1/projects/1/invoices/2/void

Жишээ хүсэлт

BYL_PROJECT_ID="таны төслийн ID"
BYL_TOKEN="таны API token"
$ curl -X POST https://byl.mn/api/v1/projects/$BYL_PROJECT_ID/invoices/2/void \
    -H "Authorization: Bearer $BYL_TOKEN" \
    -H 'Accept: application/json'

Жишээ гаралт

{
  "data": {
    "id": 5708,
    "status": "void",
    "amount": 10,
    "description": "First invoice",
    "customer_id": null,
    "number": "BYL-0008",
    "project_id": 5,
    "url": "https://byl.mn/h/invoice/5708/XN3GbRBxTslkMCeDj10CJtqlHiPfcmZ8",
    "due_date": "2023-09-08T16:33:41.000000Z",
    "created_at": "2023-09-07T16:33:41.000000Z",
    "updated_at": "2023-09-07T16:33:50.000000Z"
  }
}

Нэхэмжлэх устгах

• HTTP Method: DELETE
• Content Type: application/json
• URL: https://byl.mn/api/v1/projects/1/invoices/2

Жишээ хүсэлт

BYL_PROJECT_ID="таны төслийн ID"
BYL_TOKEN="таны API token"
$ curl -X DELETE https://byl.mn/api/v1/projects/$BYL_PROJECT_ID/invoices/2 \
    -H "Authorization: Bearer $BYL_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'

Жишээ гаралт

{
  "data": {
    "id": 2,
    "deleted_at": "2023-09-07T16:30:35.000000Z"
  }
}