Integrate Salvy with 2,000+ apps and services

Archive an asset (reversible with Unarchive)

Create an asset

Add a note to an asset’s timeline

Delete an asset permanently. Unlike Archive, this cannot be undone through the API.

Get an asset by ID

List your company assets, newest first by default

Unarchive an asset, setting the status it returns to

Update an asset. Only the fields you set are changed.

Download the signed PDF of an asset statement. Returns 409 while the statement is not signed.

Get an asset responsibility or return statement by ID

List asset responsibility and return statements, including those sent from the dashboard, newest first

Send a responsibility or return statement to the employee for e-signature by email. In sandbox no email is sent; use Simulate Signature.

Simulate the employee signing a statement: it becomes signed, the signed PDF becomes available and the asset-statement.signed webhook fires. Sandbox only.

List the companies the credential can access: a company key returns its own company; an organization key returns every company in the organization

Create a cost center

Delete a cost center, moving its phone accounts and employees to a replacement cost center (or to none)

Get a cost center by ID

List your company cost centers, sorted by name

Update a cost center. Only the fields you set are changed.

Create or update many employees at once, matched by your integrationId, all or nothing. Runs in the background and returns a task ID (see Task > Get).

Create an employee

Delete an employee together with everything your integrations brought in about them. Cannot be undone through the API.

Get an employee by ID

List your company employees, newest first by default

Update an employee. Only the fields you set are changed; an empty value clears your edit and falls back to integration data, if any.

Download the PDF (DANFE) of the invoice’s NF-e, when there is one

Download the XML of the invoice’s NF-e, when there is one

Download the invoice PDF with the current payment data (boleto and Pix). Not available in sandbox (always 404).

Get an invoice by ID, with its items, NF-e and per-line breakdown

List invoices sorted by due date

List the per-phone-account breakdown of an invoice, highest amount first. Empty for non-telecom invoices.

Retry the activation of an existing mobile phone account. Does not create a new line. Retrying on an active or activating line has no effect.

Apply a cost center to many phone accounts at once, all or nothing. Runs in the background and returns a task ID (see Task > Get).

Block a phone account. Blocking an already blocked line has no effect.

Cancel a phone account, immediately or at the end of the current billing cycle (scheduled)

Create a mobile phone account with a physical SIM or an eSIM. The line starts pending activation; billing starts after activation.

Create a mobile DID (virtual number) phone account. It is available right away; billing starts when the number is validated in an app. In sandbox only area code 41 is accepted.

Get a phone account by ID

Get the data balance of an active phone account, refreshing it first when the last reading is stale

Get the eSIM activation data of a phone account. While provisioning, status is "provisioning" and the other fields are null; poll again shortly.

List your company phone accounts, newest first

List the SMS messages received by a DID phone account, newest first. Other line types return an empty list.

Simulate an incoming SMS on a phone account. Sandbox only.

Add data to the allowance of a mobile or global phone account

Unblock a phone account. Blocks placed by Salvy (non-payment, company cancellation, partial block) are not lifted here.

Undo a scheduled cancellation so the phone account keeps working after the billing cycle ends

Update a phone account. Only the fields you set are changed.

Create a phone account group. If a group with the same name already exists, it is returned unchanged.

Delete a phone account group. Its phone accounts stay active and end up without a group.

Get a phone account group by ID

List your company phone account groups, sorted by name

Update a phone account group. Only the fields you set are changed.

Get a mobile plan available to your company by ID

List the mobile plans available to your company, sorted by name

Get the progress of a background task started by one of your API keys, with applied, failed, pending and canceled item counts

List the result of each processed item of a task, in the order the items were submitted. The "type" field tells the task kind and the shape of each item in "data".