REST API

Overview of Perk's REST API: available Travel API and Spend API endpoints, base domains, and where to find full API documentation.

Perk's REST API is currently made up of two separate APIs:

  • Travel API uses the base domain https://api.perk.com and covers trips, bookings, invoices, and users. You can find this documentation in the API reference.
  • Spend API (formerly known as the Yokoy API) covers expenses, transactions, invoicing and accounts-payable (AP) automation, and related spend resources. The full Spend API documentation — including getting started, authentication, and the complete API reference — is available at developer.yokoy.ai.

JSON will be returned in all responses, as well as errors. We use standard features of HTTP, like verbs, which can be understood by most clients.

📘

Note

Previous integrations may be using the https://api.travelperk.com base domain. Any calls to this domain are still accepted; however, we recommend your adjust your integration to point to the new domain as future compatibility with the travelperk domain is not guaranteed.

Available endpoints

Travel API endpoints

Related objectResource pathDescription
Invoice profileshttps://api.perk.com/profilesFetch your payment profiles (company Perk invoices to).
Invoiceshttps://api.perk.com/invoicesFetch and search your invoices. Includes information as granular as invoice lines.
Users (Management via SCIM)https://app.perk.com/api/v2/scim/UsersCreate, update and delete a Perk user.
Usershttps://api.perk.com/usersRead-only view of Perk user information.
TravelSafehttps://api.perk.com/travelsafe/*Fetch multiple resources related to the TravelSafe API.
Tripshttps://api.perk.com/tripsFetch summarized trip information.
Bookingshttps://api.perk.com/bookingsFetch information about bookings in trips.
Cost Centershttps://api.perk.com/cost_centersCreate, fetch and update cost centers in the Perk platform.

Spend API endpoints

Related objectResource pathDescription
Expensehttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/expensesFetch expenses, including attachments and receipts.
Trip expenseshttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/tripsFetch trips that group related expenses together. This is distinct from the Travel API's Trips endpoint above, which returns travel booking itineraries.
FX rateshttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/fx-rate-sourcesFetch and apply foreign exchange rate sources.
Custom fields for cost allocation (tags)https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/tagsFetch and manage custom tags for a legal entity.
Tax rateshttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/tax-ratesFetch and manage tax rates for a legal entity.
Expense categoryhttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/categoriesFetch and manage expense categories for a legal entity.
Company cardhttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/company-cardsFetch and manage company cards issued to a legal entity.
Employe policyhttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/policiesFetch and manage spend policies for a legal entity.
Transactionhttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/transactionsFetch and create card transactions.
Card accounthttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/card-accountsFetch card accounts and balances.
Daily statementhttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/card-accounts/{CARD_ACCOUNT_ID}/daily-statementsFetch and download daily card statements.
Invoice (invoice processing)https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/invoicesFetch, submit, and process incoming invoices for accounts payable automation. This is distinct from the Travel API's Invoices endpoint above, which returns Perk's own billing invoices.
Invoice categoryhttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/invoice-categoriesFetch and manage invoice categories.
Invoice payment termshttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/invoice-payment-termsFetch and manage invoice payment terms.
Suppliershttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/suppliers (organization level) and https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/suppliers (legal entity level)Fetch and manage supplier records at the organization or legal entity level.
Purchase orderhttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/invoice-purchase-ordersFetch and manage purchase orders linked to invoices.
Goods receipthttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/invoice-goods-receiptsFetch and manage goods receipts linked to invoices.
External invoicehttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/external-invoicesFetch and manage externally sourced invoices.
Finance exporthttps://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/export-tasks (and the equivalent path scoped under https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/export-tasks)Trigger and monitor expense and invoice export jobs.
📘

Note

For cost objects and user management, use the Travel API endpoints listed above.