GetbeelDocs

Email the invoice to the customer

Sends the PDF courtesy copy (copia di cortesia; the legal invoice is the one SDI delivers) and optionally the FatturaPA XML to the customer (default: the customer's email on the invoice), with the payment link when the invoice has one. Only issued invoices (sent to SDI) and proformas. The attempt is stored (GET /invoices/{id}/deliveries) and sent to webhooks (invoice.emailed or invoice.email_failed); a failed send answers 502 email_failed. Test keys (gb_test_…) only reach sandbox invoices, and their emails go to the team owner only, never to the customer (sent_to shows where it went).

POST
/invoices/{id}/email

Sends the PDF courtesy copy (copia di cortesia; the legal invoice is the one SDI delivers) and optionally the FatturaPA XML to the customer (default: the customer's email on the invoice), with the payment link when the invoice has one. Only issued invoices (sent to SDI) and proformas. The attempt is stored (GET /invoices/{id}/deliveries) and sent to webhooks (invoice.emailed or invoice.email_failed); a failed send answers 502 email_failed. Test keys (gb_test_…) only reach sandbox invoices, and their emails go to the team owner only, never to the customer (sent_to shows where it went).

Autorizzazione

apiKey
headerAuthorizationBearer <token>

API key: gb_test_… or gb_live_…

id*string
Idempotency-Key?string

Recommended. Retrying with the same key and body within 24 hours replays the first response (header Idempotent-Replayed: true) instead of acting twice. The same key with a different body returns 422 idempotency_key_reused.

Lengthlength <= 255
Getbeel-Company?string

Act on one of the account's client companies (its id from GET /companies) instead of the key's own account. 404 company_not_found when the key cannot act on it.

Formatuuid
application/json
  1. body
to?array<>

Recipients; default: the customer's email on the invoice

Items1 <= items <= 10
cc?array<>

Email addresses copied on the email, up to 10. Ignored with a test key (the email goes only to the team owner).

Itemsitems <= 10
language*string
Default"it"
Value in"it""en"
message?string

A note shown above the invoice summary

Lengthlength <= 2000
attach_xml*boolean

Also attach the FatturaPA XML

Defaultfalse

Corpo della risposta

OK

application/json
  1. response
object*string
id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
invoice_id*string
kind*string
Value in"invoice""reminder"
to*array<string>
cc*array<string>
sent_to*array<string>

Where it actually went: to for live invoices; for sandbox invoices (test keys) only the team owner, never the customer

sandbox*boolean
language*string
Value in"it""en"
status*string
Value in"sending""sent""failed"
reminder_day*|

Automatic reminders: days after the due date

provider_message_id*string|null
error*string|null
created_at*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
Esempio di richiesta
curl -X POST 'https://www.getbeel.com/api/v1/invoices/string/email' \  -H 'Content-Type: application/json' \  -d '{  "language": "it",  "attach_xml": false}'
Esempio di risposta
{  "object": "invoice_email",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "invoice_id": "string",  "kind": "invoice",  "to": [    "string"  ],  "cc": [    "string"  ],  "sent_to": [    "string"  ],  "sandbox": true,  "language": "it",  "status": "sending",  "reminder_day": -9007199254740991,  "provider_message_id": "string",  "error": "string",  "created_at": "2019-08-24T14:15:22Z"}