Skip to main content
POST
edi.einvoice.submit

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
connectionRef
string
required

Your connected invoicing account; select the same account with Pramaan-Account.

Pattern: ^conn_[A-Za-z0-9]{1,64}$
documentType
enum<string>
required

National invoice or credit note.

Available options:
invoice,
credit_note
documentNumber
string
required

Number matching the XML document.

Required string length: 1 - 100
issueDate
string<date>
required

Issue date matching the XML document.

Pattern: ^(?:(?:\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])))$
currency
string
required

Currency code matching the XML document.

Pattern: ^[A-Z]{3}$
party
object
required

Recipient identified in the XML.

lines
object[]
required

Document line metadata; the XML remains authoritative.

Required array length: 1 - 1000 elements
taxes
object[]
required

Tax summary metadata; the XML remains authoritative.

Maximum array length: 100
xml
string
required

Complete unsigned national XML, at most 1 MiB. One document body only.

Required string length: 1 - 1048576
country
string
default:IT

Submitting country; Italy only.

Allowed value: "IT"

Response

The result

status
enum<string>
required

Queued, accepted by the exchange, or rejected; delivery is separate.

Available options:
pending,
accepted,
rejected
ref
string

Reference to what this call created. Pass it as ref to edi.einvoice.status.get.