- US
- Australia
Base URL: https://api.usw.gorelo.io/
API Reference: https://api.usw.gorelo.io/swagger
API Reference: https://api.usw.gorelo.io/swagger
تستخدم صفحات نقاط النهاية في مرجع API عنوان URL الأساسي للولايات المتحدة افتراضيًا. إذا كانت بياناتك مستضافة في أستراليا، فانقر على عنوان URL الأساسي في أعلى صفحة نقطة النهاية وحدد
https://api.aue.gorelo.io.
أمثلة على الطلبات
توضّح مقتطفات JavaScriptfetch التالية كيفية المصادقة باستخدام ترويسة X-API-Key. استبدل YOUR_API_KEY بمفتاحك واستبدل عنوان URL الأساسي بالمنطقة التي تستضيف بياناتك.
GET
POST
النطاقات والصلاحيات
يمكن أن تكون مفاتيح API محددة النطاق. إذا كان المفتاح يفتقر إلى الوصول لنقطة نهاية معينة، تُرجع واجهة API الخطأ 403 Forbidden. يمنح نطاق Documents المفتاح حق الوصول إلى المستندات.الحقول المخصصة
تتضمن الحقول المخصصة في استجابات API الحقلينIsSet وIsHidden. لإبقاء قيمة حقل مخصص خارج API، فعّل Hide Value from API لهذا الحقل.
سجل الاستيراد
عند استيراد سجلات بقيمة
CreatedOn بتاريخ سابق، لا يرسل Gorelo أي إشعارات ولا يشغّل أي عمليات أتمتة.CreatedOn بحالة Completed، لذا لن تتم فوترتها. لا يمكنك تغييرها أو حذفها عبر API بعد ذلك.
معالجة الأخطاء
معرّفات الحالات
الأصول الوكيلة
ملاحظات حول الحقول والقيم
التنبيهات
تحدد التنبيهات الأصل المرتبط بها باستخدامAgentAssetId أو CustomAssetId أو UptimeId. استخدم الحقول نفسها لتصفية التنبيهات.
العقود والفواتير
- حقول العقد: تُرجع استجابات العقود
DaysUntilDue، وUnitCostفي البنود، وAutoApproveTimeفي بند الخدمة. - أسعار بنود العقد: يُرجع
UnitPriceفي بند العقد السعر المفروض فعليًا، وليس سعر الكتالوج. - البنود القابلة للفوترة: يفوتر
POST /v1/invoicesالبنود من نوع No charge وNon-billable بقيمة 0. أرسلBillableStatusIdبالقيمة1للبنود التي يجب تحصيل رسومها. - الضريبة: تحصل بنود الفواتير والعقود التي لا تحتوي على
TaxIdعلى الضريبة التي كان التطبيق سيطبقها. لعدم فرض أي ضريبة، أرسل معرّف معدل الإعفاء الضريبي الخاص بك. - حذف العقود: يُلغي
DELETE /v1/contracts/{contractId}تنشيط العقد، كما يفعل التطبيق، بحيث يمكنك استعادته. لأرشفة العقد بدلًا من ذلك، أرسلPATCHمعStatusIdبالقيمة3.
أنواع العناصر المرتبطة بالمستندات
نوع العنصر المرتبط4 في المستندات هو Agent asset. تستمر عمليات التكامل التي تطابق حسب معرّف النوع في العمل. يجب على عمليات التكامل التي تطابق حسب اسم النوع استخدام Agent asset.