Sync scope provides limited API functionality, focusing on reading current data for the organizations the partner has been authorized for. This scope includes the following capabilities for the partner app:

Capabilities

  • Organization Data: Read basic information about the organization, such as the full legal name, credit limit, and status.
  • Cardholder Data: Access cardholder information, including title, name, email address, mobile number, and status.
  • Card Data: Read basic card information (excluding limit, spending data, and card security details).
  • Account Entries: Access account entry data, such as transactions, platform fees, and bill payments.
  • Receipts: Download and receive updates about receipts.

Scope Applicability

This scope is suitable for partners with the following requirements:

  • Ad Hoc Data Pulls:
    • Data is retrieved on-demand via explicit manual requests by the partner application or at regular intervals (e.g., daily).
  • Booked Data Only:
    • Access is limited to items that have been booked on the customer organization's credit card account, including settled transactions, paid bill payments, and booked fees.
    • Pending transactions and upcoming or pending bill payments are not available in this scope. For these, an Expense Management scope is required.
  • No Webhook Integration:
    • Partners do not need near-real-time updates via webhook for transaction and payment events (e.g., updating pending transaction statuses). The only exception is receipt callbacks.
  • Read-Only Access:
    • No data manipulation is required; the scope provides simple one-way read access.
  • Dual-App Usage:
    • Customers use both the Pliant app and the partner app.

Use Case Example

Accounting Software Integration

A partner app designed as an accounting software solution only needs transaction and payment data that appear as booked accounting entries. Since accountants typically review card transactions and process accounting entries in batches (e.g., monthly or weekly), real-time data pushes are unnecessary. Instead, periodic data retrieval is sufficient to meet the requirements.