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 metadata
- PUTReplace entity metadata
- GETGet entity settings
- PATCHUpdate entity settings
- GETGet an entity of this user
- PATCHUpdate an entity of this user
Payment methods
Entity VAT IDs
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
VAT rates
Webhook deliveries
Webhook subscriptions
Identity
- GETLists all applications across the caller's organization hierarchy with child organization type counts.
- PATCHUpdates payment rail scopes for an application.
- POSTDisables an application.
- POSTEnables an application.
- GETGets the enabled status of 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.
- POSTEnables an organization by clearing its deactivation timestamp.
- POSTEnables all applications for an organization.
- GETGets all applications for an organization.
- GETLists users from organizations that have a downstream relationship with the caller's organization.
- POSTCreates a new user in the specified organization.
- GETGets a single user from a downstream organization in the hierarchy.
- POSTDisables a user by setting their status to INACTIVE.
- POSTEnables a user by setting their status to ACTIVE.
Gets details for a specific organization.
Copy
Ask AI
curl --request GET \
--url https://api.sandbox.tesouro.com/identity/v1/organizations/{organizationId} \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"displayName": "<string>",
"isEnabled": true,
"legalName": "<string>",
"shortName": "<string>",
"types": [
"BANK"
],
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"country": "<string>",
"postalCode": "<string>",
"stateOrProvince": "<string>"
},
"childOrganizationTypeCounts": {},
"domainName": "<string>",
"embeddedBusinessData": {
"businessStructureType": "<string>",
"formationDate": "2023-12-25",
"naicsCode": "<string>",
"taxId": {
"maskedTaxId": "<string>",
"taxIdType": "<string>"
}
},
"phoneNumber": "<string>"
}Identity
Gets details for a specific organization.
The caller must have a relationship with the target organization to access its details. Requires the org:read:all scope.
Token types: APP, USER | Required scopes: org:read:all
GET
/
identity
/
v1
/
organizations
/
{organizationId}
Gets details for a specific organization.
Copy
Ask AI
curl --request GET \
--url https://api.sandbox.tesouro.com/identity/v1/organizations/{organizationId} \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"displayName": "<string>",
"isEnabled": true,
"legalName": "<string>",
"shortName": "<string>",
"types": [
"BANK"
],
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"country": "<string>",
"postalCode": "<string>",
"stateOrProvince": "<string>"
},
"childOrganizationTypeCounts": {},
"domainName": "<string>",
"embeddedBusinessData": {
"businessStructureType": "<string>",
"formationDate": "2023-12-25",
"naicsCode": "<string>",
"taxId": {
"maskedTaxId": "<string>",
"taxIdType": "<string>"
}
},
"phoneNumber": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the organization to retrieve.
Response
Returns the organization details.
Response DTO for the organization details endpoint.
The unique identifier of the organization.
The display name of the organization.
Whether the organization is currently enabled (active within the time window).
The legal name of the organization.
A short identifier for the organization.
The types assigned to the organization (e.g., VSP, Bank).
Available options:
BANK, EMBEDDED, PLATFORM, TRANSACTOR, VERTICAL_SOFTWARE_PROVIDER The organization's address, if available.
Show child attributes
Show child attributes
Counts of direct child organizations grouped by type (e.g., {"VERTICAL_SOFTWARE_PROVIDER": 3, "EMBEDDED": 2}). Empty dictionary if the organization has no children.
Show child attributes
Show child attributes
The domain name / website of the organization.
Embedded business entity data, populated when the target organization has embedded data.
Show child attributes
Show child attributes
The organization's phone number, if available.
Was this page helpful?
Gets all organization IDs visible to the caller by traversing the hierarchy downward.Updates an organization's fields. Only provided fields are updated; omitted fields remain unchanged.
⌘I
Assistant
Responses are generated using AI and may contain mistakes.