Withholdings

Email withholding

POST
/v1/ec/withholdings/{id}/email

Queues an email with the RIDE and the authorized XML. In every environment the document is already sent on its own when it is authorized, to its recipient; this send is for resending it, to its recipient or to the addresses you give.

Authorization

AuthorizationBearer <token>

Your API key, which acts for the one business it was created for: fb_sandbox_… issues in sandbox, fb_test_… in test, the tax authority's testing service, and fb_live_… in live.

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

to?array<>

Who to send it to. If you omit it, it goes to the document's recipient, in any environment.

Items1 <= items <= 10

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/ec/withholdings/497f6eca-6276-4993-bfeb-53cbbbba6f08/email" \  -H "Content-Type: application/json" \  -d '{}'
{  "object": "email",  "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",  "to": [    "string"  ]}