Accounting connections
Accounting synchronized records
Accounting tax rates
Accounting data pull
Analytics
Approval policies
Approval requests
Entity bank accounts
Cost centers
Counterparts
Counterpart addresses
Counterpart bank accounts
Counterpart contacts
Counterpart VAT IDs
Delivery notes
PDF templates
Documents
Entities
- GETGet all entities
- POSTCreate an entity
- GETGet the current entitydeprecated
- PATCHUpdate the current entitydeprecated
- GETGet an entity
- PATCHUpdate an entity
- POSTActivate an entity
- POSTDeactivate an entity
- PUTUpload an entity logo
- DELDelete an entity's logo
- GETGet entity settings
- PATCHUpdate entity settings
- GETGet an entity of this user
- PATCHUpdate an entity of this user
Payment methods
Entity users
Ledger accounts
Mail templates
Mailbox domains
Measure units
Overdue reminders
Credit notes
- GETGet credit notes
- POSTCreate a credit note
- POSTUpload a credit note from a file
- GETGet credit note validations
- PUTUpdate credit note validations
- POSTReset credit note validations
- GETGet a credit note by ID
- DELDelete a credit note
- PATCHUpdate a credit note
- POSTApprove a credit note
- POSTCancel a credit note
- POSTCancel OCR of a credit note
- GETGet all line items of a credit note
- PUTReplace all line items of a credit note
- POSTAdd a new line item to a credit note
- GETGet a single line item of a credit note
- DELDelete a line item from a credit note
- PATCHUpdate a line item of a credit note
- POSTReject a credit note
- POSTSubmit a credit note for approval
- GETValidate a credit note
Purchase orders
Payables
- GETGet payables
- POSTCreate a payable
- GETGet payables analyticsdeprecated
- POSTUpload a payable from a file
- GETGet payables validations
- PUTUpdate payables validations
- POSTReset payables validations
- GETGet the available variables for payable email templates
- GETGet a payable by ID
- DELDelete a payable
- PATCHUpdate a payable
- POSTApprove a payable for payment
- POSTAttach a file to a payable
- POSTCancel a payable
- POSTCancel OCR of a payable
- GETReturns the history of the specified accounts payable document.
- POSTMark a payable as paid
- POSTMark a payable as partially paid
- POSTReject a payable
- POSTReopen a rejected or waiting_to_be_paid payable
- POSTSubmit a payable for approval
- GETGet suggestions
- DELDelete suggestions
- POSTValidate a payable
Payable line items
Payment intents
Payment records
Payment reminders
Payment terms
Products
Projects
Receipts
- GETGet receipts
- POSTCreate a receipt
- POSTUpload a receipt from a file
- GETGet a receipt by ID
- DELDelete a receipt
- PATCHUpdate a receipt
- POSTAttach a file to a receipt
- GETGet all line items of a receipt
- POSTAdd a new line item to a receipt
- DELDelete a line item from a receipt
- PATCHUpdate a line item of a receipt
Receivables
- GETGet receivables
- POSTCreate a receivable
- GETGet required field names for invoice creation
- POSTSearch receivables
- GETGet email template variables
- GETGet a receivable by ID
- DELDelete a receivable
- PATCHUpdate a receivable
- POSTAccept a quote
- POSTCancel an invoice
- POSTClone a receivable
- POSTDecline a quote
- GETGet a receivable's history
- GETGet a receivable's history record by ID
- POSTIssue a receivable
- PUTUpdate the line items of a receivable
- GETGet a list of all mails sent by receivable
- GETGet a mail sent by receivable
- POSTMark an invoice as paid
- POSTMark an invoice as partially paiddeprecated
- POSTMark an invoice as uncollectible
- GETGet a link to the PDF version of a receivable
- POSTPreview a receivable's email message
- POSTSend a receivable via email
- POSTSend a test reminder
- POSTVerify a receivable
Text templates
Transactions
- GETGet transactions
- POSTCreate a transaction
- POSTCreate multiple transactions
- GETGet required fields configuration
- PUTUpdate required fields configuration
- GETGet a transaction
- DELDelete a transaction
- PATCHUpdate a transaction
- POSTApprove a transaction
- POSTReject a transaction
- POSTReopen a rejected transaction
- POSTSubmit a transaction for approval
- POSTValidate a transaction against required fields configuration
VAT rates
Webhook deliveries
Webhook subscriptions
Identity
- GETLists all departments for the caller's organization.
- POSTCreates a new department in the caller's organization.
- GETGets a department by ID.
- PUTUpdates a department in the caller's organization.
- DELDeactivates a department in the caller's organization.
- PUTAssigns a user to a department.
- DELRemoves a user from a department.
- GETLists all locations for the caller's organization.
- POSTCreates a new location in the caller's organization.
- GETGets a location by ID.
- PUTUpdates a location in the caller's organization.
- DELDeactivates a location in the caller's organization.
- PUTAssigns a user to a location.
- DELRemoves a user from a location.
- GETLists all applications across the caller's organization hierarchy with child organization type counts.
- GETGets an application by ID, including its scopes and enabled status.
- PATCHUpdates payment rail scopes for an application.
- POSTDisables an application.
- POSTEnables an application.
- GETLists organizations that have a relationship with the caller's organization.
- POSTCreates a new organization as a child of the caller's organization.
- GETGets all organization IDs visible to the caller by traversing the hierarchy downward.
- GETGets details for a specific organization.
- PATCHUpdates an organization's fields. Only provided fields are updated; omitted fields remain unchanged.
- POSTDisables an organization by setting its deactivation timestamp.
- POSTDisables all applications for an organization.
- GETGets disabled payment rails for an organization.
- PATCHUpdates payment rail status for an organization.
- POSTEnables an organization by clearing its deactivation timestamp.
- POSTEnables all applications for an organization.
- GETGets all applications for an organization.
- GETGets settings for an organization.
- PATCHUpdates settings for an organization.
- GETLists users from the target organization and all its descendants.
- POSTCreates a new user in the specified organization.
- GETGets a single user from a downstream organization in the hierarchy.
- PATCHUpdates profile fields for a user in a downstream organization.
- POSTDisables a user by setting their status to INACTIVE.
- POSTEnables a user by setting their status to ACTIVE.
Lists users from the target organization and all its descendants.
curl --request GET \
--url https://api.sandbox.tesouro.com/identity/v1/users \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdDateTime": "2023-11-07T05:31:56Z",
"email": "<string>",
"isExpenseApprover": true,
"name": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationName": "<string>",
"status": "<string>",
"department": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"jobTitle": "<string>",
"lastLoggedInDateTime": "2023-11-07T05:31:56Z",
"location": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"role": "<string>"
}
],
"nextPaginationToken": "<string>",
"prevPaginationToken": "<string>"
}Identity
Lists users from the target organization and all its descendants.
Returns users from the target organization AND all organizations below it in the hierarchy. When X-Organization-ID header is provided, uses that org as target (if visible to caller). When no header is provided, defaults to the caller’s own organization. Supports optional filtering by organization type, user status, and pagination. Requires the user:read scope.
Token types: APP, USER | Required scopes: user:read
GET
/
identity
/
v1
/
users
Lists users from the target organization and all its descendants.
curl --request GET \
--url https://api.sandbox.tesouro.com/identity/v1/users \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdDateTime": "2023-11-07T05:31:56Z",
"email": "<string>",
"isExpenseApprover": true,
"name": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationName": "<string>",
"status": "<string>",
"department": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"jobTitle": "<string>",
"lastLoggedInDateTime": "2023-11-07T05:31:56Z",
"location": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"role": "<string>"
}
],
"nextPaginationToken": "<string>",
"prevPaginationToken": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
ID of the organization to scope this operation to. When omitted, users from the target org and all its descendants are returned. Must be a valid non-empty UUID. Present but empty or malformed values return 400.
Query Parameters
Filter by organization type (VERTICAL_SOFTWARE_PROVIDER, EMBEDDED).
Available options:
BANK, EMBEDDED, PLATFORM, TRANSACTOR, VERTICAL_SOFTWARE_PROVIDER Maximum number of results to return (default: 20, max: 100).
Opaque pagination token from a previous response for cursor-based navigation.
Filter by user status (default: ACTIVE). Filter for user status when querying users.
Available options:
ACTIVE, INACTIVE, INVITED, ALL Response
Returns the list of users from related organizations.
Response DTO for listing users from related organizations.
Show child attributes
Show child attributes
A token to pass as pagination_token to get the next page of results. Null if there are no more pages after this one.
A token to pass as pagination_token to get the previous page of results. Null if this is the first page.
Was this page helpful?
⌘I
Assistant
Responses are generated using AI and may contain mistakes.