Deel
Deel invoices, payment breakdowns, invoice adjustments and contracts through an Organization token created by a Deel organization admin in Developer Center (More > Developer). Recommended read-only scopes: accounting:read, invoice-adjustments:read and contracts:read.
What the connection reaches
- GET /invoices and GET /payments/{id}/breakdown with accounting:read
- GET /invoice-adjustments with invoice-adjustments:read
- GET /contracts with contracts:read
- Status
- Built into the pipeline SDK
- Connection class
- DeelConnection
- Credential
- Organization API token
Connect Deel
Three steps, the same for every connection. The credential goes to the platform, never into the repository or pipeline code.
- 1
Declare it in connections/connections.py
connections/connections.py from segmentstream.connections import DeelConnection connections = ( DeelConnection(key="deel"),) - 2
Deploy
$ segmentstream deploy - 3
Connect
A Deel organization admin creates an Organization token in Developer Center (More > Developer > Access Tokens). Select accounting:read, invoice-adjustments:read and contracts:read for read-only access. See https://developer.deel.com/api/stable/authentication.md.
- 4
Then
Paste the Organization API token (Deel > More > Developer > Access Tokens) into the connection in the console, or configure it from the terminal with a hidden prompt. API-key connections need no authorisation step: once the value is set, the connection is connected.
$ segmentstream connection configure deel - 5
Then
Check connectivity with GET /invoices?limit=1 through the connection client. This cheap read needs only accounting:read, including when the organization has no invoices.
Use it
Code asks for the connection by its key. The platform adds the credential on the way out.
import segmentstream as s with s.get_connection("deel").get_http_client() as client: response = client.get("/invoices", params={"limit": 1}) response.raise_for_status()Or ask your agent
“Connect Deel and load invoices, payment breakdowns, invoice adjustments and contracts.”
Part of these solutions
More in People
Want Deel set up for you?
Our forward-deployed engineers build one solution on your data, in your own workspace, as code you own. Tell us what you run today and what you want; your note goes straight to our founder.
- One solution, on your data, in your own workspace
- First version live in two weeks
- Parity proven before anything is switched off
- Fixed scope and price, credited to your contract if you continue
Not ready for a pilot? Send the form anyway with your question. An engineer will reply, not a sales rep.
How the pilot worksConnect what your company runs.
Our engineers build the first version on your data in two weeks, at a fixed price.
Or join the waitlist for self-serve:
Self-serve opens to the waitlist first.