TYPE REFERENCE

`Me`

Referenced by 1 generated operations.

Documented fields

Required Optional

appPermissionsAppPermissions!Required
Boolean app control permissions.
Show children
- exportReportsBoolean!Required
  May export reports.
- manageUsersBoolean!Required
  May manage users.
- viewOrdersBoolean!Required
  May view orders.
appRoleAppRole!Required
ADMIN for owner/admin; USER for other roles.
- ADMINOwner or administrator.
- USERAccountant, supervisor, operator or QC.
organisationOrganisation!Required
The caller’s shop.
Example: {"id":"0192f0c1-0000-7000-8000-00000000000a","name":"Demo Precision Works","timezone":"Asia/Kolkata"}
Show children
- addressAddress!Required
  Registered address.
  Show children
  - addressString!Required
    Building and street, app spelling.
  - cityString!Required
    City or town.
  - countryString!Required
    Country; India by default.
  - line1String!Required
    Building, street.
  - line2StringOptional
    Area, landmark.
  - pinCodeString!Required
    Six digit postal code, app spelling.
  - pincodeString!Required
    6-digit PIN code.
  - stateString!Required
    State name.
- businessTypeString!Required
  businessType organisation setting.
- cityString!Required
  Shop city.
- codeString!Required
  code organisation setting.
- countryString!Required
  country organisation setting.
- createdAtString!Required
  createdAt organisation setting.
- defaultTaxRateFloatOptional
  Default active GST percent.
- emailString!Required
  email organisation setting.
- fyStartMonthInt!Required
  Month the financial year starts, 1–12 (4 = April).
- gstRegisteredBoolean!Required
  GST registration enabled.
- gstStateString!Required
  gstState organisation setting.
- gstinStringOptional
  GSTIN, if registered.
- idID!Required
  The shop id (the tenant).
  Example: "0192f0c1-0000-7000-8000-00000000000a"
- industryString!Required
  industry organisation setting.
- invoiceFooterString!Required
  invoiceFooter organisation setting.
- invoiceLogoAppFileReferenceOptional
  invoiceLogo file reference.
  Show children
  - idID!Required
    File id; obtain authorised download URL from files API.
  - kindStringOptional
    Document category.
  - nameString!Required
    Display filename.
  - sizeBytesFloat!Required
    Size in bytes, safe integer.
- invoicePrefixString!Required
  Prefix of invoice numbers.
- invoiceStartNumberInt!Required
  Starting sequence within GSTIN and FY.
- logoAppFileReferenceOptional
  logo file reference.
  Show children
  - idID!Required
    File id; obtain authorised download URL from files API.
  - kindStringOptional
    Document category.
  - nameString!Required
    Display filename.
  - sizeBytesFloat!Required
    Size in bytes, safe integer.
- nameString!Required
  Trade name.
  Example: "Demo Precision Works"
- phoneString!Required
  phone organisation setting.
- pinCodeString!Required
  Shop PIN code.
- registrationDetailsString!Required
  registrationDetails organisation setting.
- shortNameString!Required
  shortName organisation setting.
- signatureAppFileReferenceOptional
  signature file reference.
  Show children
  - idID!Required
    File id; obtain authorised download URL from files API.
  - kindStringOptional
    Document category.
  - nameString!Required
    Display filename.
  - sizeBytesFloat!Required
    Size in bytes, safe integer.
- stateString!Required
  Shop address state.
- stateCodeString!Required
  GST state code (2 digits); decides CGST+SGST or IGST.
- taxRates[TaxRate!]!Required
  At most 50 rates.
  Show children
  - activeBoolean!Required
    Available on new invoices.
  - idID!Required
    Rate id.
  - rateFloat!Required
    Percent, 0–100, at most two decimals.
- termsAndConditionsString!Required
  termsAndConditions organisation setting.
- timezoneString!Required
  IANA timezone people read times in.
  Example: "Asia/Kolkata"
- websiteString!Required
  website organisation setting.
permissions[String!]!Required
Actions the caller may perform; hide controls that are not here.
Example: ["org.read","org.manage","users.read","users.manage","customers.read","customers.write","customers.delete"]
Deprecated: Use appPermissions (alias as permissions in app queries).
userUser!Required
The caller.
Example: {"id":"0192f0c1-0000-7000-8000-0000000000a1","name":"Asha Demo","role":"OWNER"}
Show children
- activityActivityConnection!Required
  Newest activity first, cursor paged.
  Field arguments
  - afterStringOptional
    endCursor of the previous page.
  - beforeStringOptional
    startCursor of the next page, when paging backwards.
  - firstIntOptional
    Page size, 1–100 (default 20).
  - lastIntOptional
    Page size when paging backwards, 1–100.
  Show children
  - edges[ActivityEdge!]!Required
    The rows on this page, in order.
    Show children
    cursorString!Required
    Opaque position of this row in the list.
    nodeActivityEntry!Required
    The Activity.
  - pageInfoPageInfo!Required
    Whether more pages exist, and the cursors to reach them.
    Show children
    endCursorStringOptional
    Cursor of the last row; pass it as after to get the next page. Null when the page is empty.
    hasNextPageBoolean!Required
    Whether another page follows this one.
    hasPreviousPageBoolean!Required
    Whether another page comes before this one.
    startCursorStringOptional
    Cursor of the first row; pass it as before to page backwards. Null when the page is empty.
  - totalCountInt!Required
    All rows matching the filter and search, not just this page.
- addressString!Required
  address from the user profile.
- cityString!Required
  city from the user profile.
- countryString!Required
  country from the user profile.
- createdAtString!Required
  UTC time the user was added.
- departmentString!Required
  department from the user profile.
- designationString!Required
  designation from the user profile.
- documents[AppFileReference!]!Required
  At most 20 document references.
  Show children
  - idID!Required
    File id; obtain authorised download URL from files API.
  - kindStringOptional
    Document category.
  - nameString!Required
    Display filename.
  - sizeBytesFloat!Required
    Size in bytes, safe integer.
- emailStringOptional
  Sign-in email, if any.
- hasPasswordBoolean!Required
  Whether a password has been set.
- idID!Required
  Stable id (UUIDv7).
  Example: "0192f0c1-0000-7000-8000-0000000000a1"
- joinedAtString!Required
  Membership business date, YYYY-MM-DD.
- lastLoginAtStringOptional
  UTC time of the last sign-in; null if never.
- nameString!Required
  Full name.
  Example: "Asha Demo"
- permissionsAppPermissions!Required
  Role-capped app controls.
  Show children
  - exportReportsBoolean!Required
    May export reports.
  - manageUsersBoolean!Required
    May manage users.
  - viewOrdersBoolean!Required
    May view orders.
- phoneStringOptional
  Sign-in phone, if any.
- photoAppFileReferenceOptional
  Profile photo reference.
  Show children
  - idID!Required
    File id; obtain authorised download URL from files API.
  - kindStringOptional
    Document category.
  - nameString!Required
    Display filename.
  - sizeBytesFloat!Required
    Size in bytes, safe integer.
- pinCodeString!Required
  pinCode from the user profile.
- roleRoleName!Required
  Their role in this shop.
  Example: "OWNER"
  - ACCOUNTANTCustomers, invoices and payments.
  - ADMINManages people, settings and customers on the owner’s behalf.
  - OPERATORRuns machines and logs production.
  - OWNERRuns the shop. Everything, including who else can sign in.
  - QCInspects parts and records results.
  - SUPERVISORPlans and watches the shop floor.
- stateString!Required
  state from the user profile.
- statusUserStatus!Required
  Whether they can sign in.
  - ACTIVECan sign in.
  - INACTIVECannot sign in; their sessions were revoked. History stays.
  - INVITEDInvitation pending.
  - SUSPENDEDAccess suspended; history retained.

Used by

meMock