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.comand 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.
NotePrevious integrations may be using the
https://api.travelperk.combase 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 object | Resource path | Description |
|---|---|---|
| Invoice profiles | https://api.perk.com/profiles | Fetch your payment profiles (company Perk invoices to). |
| Invoices | https://api.perk.com/invoices | Fetch and search your invoices. Includes information as granular as invoice lines. |
| Users (Management via SCIM) | https://app.perk.com/api/v2/scim/Users | Create, update and delete a Perk user. |
| Users | https://api.perk.com/users | Read-only view of Perk user information. |
| TravelSafe | https://api.perk.com/travelsafe/* | Fetch multiple resources related to the TravelSafe API. |
| Trips | https://api.perk.com/trips | Fetch summarized trip information. |
| Bookings | https://api.perk.com/bookings | Fetch information about bookings in trips. |
| Cost Centers | https://api.perk.com/cost_centers | Create, fetch and update cost centers in the Perk platform. |
Spend API endpoints
| Related object | Resource path | Description |
|---|---|---|
| Expense | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/expenses | Fetch expenses, including attachments and receipts. |
| Trip expenses | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/trips | Fetch trips that group related expenses together. This is distinct from the Travel API's Trips endpoint above, which returns travel booking itineraries. |
| FX rates | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/fx-rate-sources | Fetch 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}/tags | Fetch and manage custom tags for a legal entity. |
| Tax rates | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/tax-rates | Fetch and manage tax rates for a legal entity. |
| Expense category | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/categories | Fetch and manage expense categories for a legal entity. |
| Company card | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/company-cards | Fetch and manage company cards issued to a legal entity. |
| Employe policy | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/policies | Fetch and manage spend policies for a legal entity. |
| Transaction | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/transactions | Fetch and create card transactions. |
| Card account | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/card-accounts | Fetch card accounts and balances. |
| Daily statement | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/card-accounts/{CARD_ACCOUNT_ID}/daily-statements | Fetch and download daily card statements. |
| Invoice (invoice processing) | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/invoices | Fetch, 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 category | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/invoice-categories | Fetch and manage invoice categories. |
| Invoice payment terms | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/invoice-payment-terms | Fetch and manage invoice payment terms. |
| Suppliers | https://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 order | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/invoice-purchase-orders | Fetch and manage purchase orders linked to invoices. |
| Goods receipt | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/invoice-goods-receipts | Fetch and manage goods receipts linked to invoices. |
| External invoice | https://api.yokoy.ai/v1/organizations/{ORGANIZATION_ID}/legal-entities/{LEGAL_ENTITY_ID}/external-invoices | Fetch and manage externally sourced invoices. |
| Finance export | https://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. |

