Jump to Content
Guides
REST API
Changelog
v1.0
Tipalti Developer Hub »
REST API
Tipalti Developer Hub »
v1.0
Guides
REST API
Changelog
Introduction
All
Pages
Start typing to search…
JUMP TO
Get started
Quick start guide
Environments
Conventions
Main workflows
Onboard payees and create invoices
Onboard payees and create payments
Update payment status with webhooks
Check payment status
specifications
Introduction
Rate limit
API request overview
Pagination
Filters
API responses
HTTP status codes
Sync/Async Responses
Payees business logic errors
Payment batch business logic errors
Custom field business logic errors
Invoice batch business logic errors
Tax code business logic errors
Payment terms business logic errors
IDs usability
OAuth 2.0 Authorization Flows
Authentication and authorization
Access scopes
Client credentials flow
Create app with client credentials flow
API access token
Step 1: Retrieve access token
Step 2: Use access token for REST API requests
Postman collection for client credentials
Authorization code flow
Create app with Authorization code flow
Proof Key for Code Exchange (PKCE)
API tokens
Step 1: Create an authorization request link
Step 2: Request user authorization
Step 3: Retrieve tokens
Step 4: Use access token for REST API requests
Step 5: Get a new access token using a refresh token
Postman collection
Endpoints
Custom fields
Get list of custom fields
get
Get custom field by ID
get
Get list of value options
get
Get value option by ID
get
Create custom field value option
post
Update value option
patch
GL accounts
Get list of GL accounts
get
Get GL account by ID
get
Invoice batches
Create invoice batch
post
Get invoice batch upload summary by ID
get
Invoices
Get list of invoices
get
Get invoice by ID
get
Get list of invoice lines
get
Get invoice line by ID
get
Payees
Create invitation to payee
post
Get invitation to payee
get
Create payee
post
Get list of payees
get
Get payee by ID
get
Update payee
patch
Update payee payment method
patch
Payer entities
Get list of payer entities
get
Get payer entity by ID
get
Payment batches
Create payment batch
post
Get payment batch upload summary by ID
get
Get payment batch instructions by ID
get
Payments
Get list of payments
get
Get payment by ID
get
Tax codes
Create tax code
post
Get list of tax codes
get
Get tax code by ID
get
Update tax code
patch
Payment terms
Create a payment term
post
Get list of payment terms
get
Get payment term by ID
get
Update a payment term
patch
references
Statuses
Add detailed payment statuses
GL Account Types
Property types
Custom fields
Introduction
Ask AI
