Preview an Invoice without issuing it

POST

/v1/invoices/preview

curl --request POST \
  --url https://api.timbro.do/v1/invoices/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "additionalInformation": { "referenceNumber": "example", "shipment": { "containerNumber": "example", "deliveryNoteNumber": "example", "driver": "example", "grossWeight": "example", "grossWeightUnit": "example", "netWeight": "example", "netWeightUnit": "example", "packageCount": "example", "packageUnit": "example", "packageVolume": "example", "route": "example", "shipmentDate": "example", "shipmentNumber": "example", "transportDocumentNumber": "example", "transportZone": "example", "vehicleFiche": "example", "vehiclePlate": "example", "volumeUnit": "example" } }, "buyer": { "address": "example", "deliveryPhone": "example", "email": "example", "legalName": "example", "taxId": "example" }, "currency": "DOP", "exchangeRate": { "rate": "example" }, "expectedTotals": { "fiscal": { "net": "example", "tax": "example", "total": "example" }, "net": "example", "nonBillable": "example", "tax": "example", "total": "example" }, "incomeType": "01", "invoiceReference": "example", "items": [ { "additionalDescription": "example", "adjustments": { "discounts": [ { "amount": "example", "kind": "fixed_amount" } ], "surcharges": [ { "amount": "example", "kind": "fixed_amount" } ] }, "description": "example", "id": "example", "itemCodes": [ { "code": "example", "typeCode": "example" } ], "kind": "good", "legalTip": true, "quantity": "example", "tax": { "included": true, "kind": "itbis_18" }, "unit": "barrel", "unitPrice": "example" } ], "numbering": { "eNcf": "example", "sequenceExpiresOn": "example" }, "paymentTerms": { "allocations": [ { "amount": "example", "method": "cash" } ], "paymentAccount": { "accountNumber": "example", "bankName": "example" }, "type": "immediate" }, "pdfLayout": "a4", "referenceInformation": { "attribution": { "fiscalOperationId": "example", "kind": "internal_operation" }, "fiscalNumber": "example", "issuedOn": "2026-04-15", "modificationCode": "4" }, "source": { "id": "example", "version": "example" }, "type": "E31" }'

• Production

Authentication

• secretKey
• integrationToken
  invoices:test
• integrationToken
  invoices:live

Request body^required

Media typeapplication/json

InvoiceRequestE31

object

buyer

required

object

legalName

required

string

>= 1 characters <= 150 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

taxId

required

string

/^[0-9]{9}([0-9]{2})?$/

address

null

null

string

string

>= 1 characters <= 100 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryPhone

null

null

string

string

/^[0-9]{3}-[0-9]{3}-[0-9]{4}$/

email

null

null

string

string

<= 80 characters /^[\p{L}\p{M}\p{N}\p{S}_]+(?:[-.][\p{L}\p{M}\p{N}\p{S}_]+)*@[\p{L}\p{M}\p{N}\p{S}]+(?:[-.][\p{L}\p{M}\p{N}\p{S}]+)*\.[\p{L}\p{M}\p{N}\p{S}]+(?:[-.][\p{L}\p{M}\p{N}\p{S}]+)*$/

currency

required

string

Allowed values: DOP BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

invoiceReference

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

items

required

Array<object>

>= 1 items <= 1000 items

object

description

required

string

>= 1 characters <= 80 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

Whether a Source line describes a good or a service.

string

Allowed values: good service

quantity

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

tax

required

discriminator: kind

object

object

included

required

boolean

kind

required

string

Allowed values: itbis_18

object

object

included

required

boolean

kind

required

string

Allowed values: itbis_16

ZeroRatedTax

object

kind

required

string

Allowed values: zero_rated

ExemptTax

object

kind

required

string

Allowed values: exempt

object

object

kind

required

string

Allowed values: non_billable

unit

required

A DGII e-CF unit of measure: a readable lowercase name on the Source and Invoice wire, the official numeric catalog code in fiscal documents.

string

Allowed values: barrel bag jar bundle bottle box cigarette_pack centimetre cylinder set container day dozen bale gallon degree gram bulk hour crate kilogram kilowatt_hour pound litre lot metre square_metre cubic_metre million_btu minute package pair foot piece roll envelope second tank ton tube yard square_yard unit element thousand sack tin display drum ration quintal gross_register_tonnage square_foot passenger inch boat_berth_stay tray hectare millilitre milligram ounce troy_ounce

unitPrice

required

string

/^[0-9]{1,16}(\.[0-9]{1,4})?$/

additionalDescription

null

null

string

string

>= 1 characters <= 1000 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

adjustments

null

null

LinePriceAdjustments

Line-level discounts and surcharges, kept separate from document-level adjustments.

object

discounts

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

surcharges

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

id

null

null

string

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

itemCodes

null

null

Array<object>

Array<object>

0 <= 5 items

object

code

required

string

>= 1 characters <= 35 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

typeCode

required

string

>= 1 characters <= 14 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

legalTip

boolean | null

paymentTerms

required

discriminator: type

object

object

type

required

string

Allowed values: immediate

allocations

null

null

Array<object>

Array<object>

>= 1 items <= 7 items

One payment method and its amount, in DOP whatever the Invoice’s currency. The allocations sum to the DOP total.

object

amount

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

method

required

Named payment methods whose official codes are owned by fiscal-document.

string

Allowed values: cash bank_transfer card credit_sale gift_certificate barter credit_note other

paymentAccount

object

accountNumber

null

null

string

string

>= 1 characters <= 28 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

bankName

null

null

string

string

>= 1 characters <= 75 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

CreditPaymentTerms

object

dueOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

type

required

string

Allowed values: credit

FreePaymentTerms

object

type

required

string

Allowed values: free

type

required

string

Allowed values: E31

Optional fields

additionalInformation

null

null

InvoiceAdditionalInformation

object

referenceNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

shipment

object

containerNumber

null

null

string

string

>= 1 characters <= 100 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryNoteNumber

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

driver

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

grossWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

grossWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

netWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

netWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageCount

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

packageUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageVolume

null

null

string

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

route

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

shipmentDate

null

null

string

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

shipmentNumber

null

null

string

string

>= 1 characters <= 25 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

transportDocumentNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

transportZone

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehicleFiche

null

null

string

string

>= 1 characters <= 10 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehiclePlate

null

null

string

string

>= 1 characters <= 7 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

volumeUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

exchangeRate

null

null

InvoiceExchangeRate

The exchange rate of record: DOP per one unit of the Invoice’s currency.

object

rate

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

expectedTotals

null

null

InvoiceExpectedTotals

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

nonBillable

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

fiscal

null

null

InvoiceFiscalExpectedTotals

DOP accounting assertions against the e-CF’s MontoTotal and its parts.

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

incomeType

null

null

string

string

Allowed values: 01 02 03 04 05 06

numbering

null

null

InvoiceNumbering

object

eNcf

required

string

/^E(31|32|33|34|41|43|44|45|46|47)[0-9]{10}$/

sequenceExpiresOn

string | null

pdfLayout

null

null

InvoicePdfLayout

string

Allowed values: a4 receipt80mm

referenceInformation

null

null

InvoiceReferenceInformation

object

attribution

required

discriminator: kind

InternalOperationReference

object

fiscalOperationId

required

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

kind

required

string

Allowed values: internal_operation

object

object

environment

required

DGII execution environment selected before lifecycle admission.

string

Allowed values: sandbox certification production

issuerTaxId

required

string

/^[0-9]{9}([0-9]{2})?$/

kind

required

string

Allowed values: external_document

sourceReference

required

string

>= 1 characters <= 250 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

fiscalNumber

required

string

/^(B[0-9]{10}|E[0-9]{12}|[AP][0-9]{18})$/

issuedOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

modificationCode

required

string

Allowed values: 4 5

source

null

null

InvoiceSourceInput

object

id

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

version

required

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

InvoiceRequestE32

object

currency

required

string

Allowed values: DOP BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

invoiceReference

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

items

required

Array<object>

>= 1 items <= 1000 items

object

description

required

string

>= 1 characters <= 80 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

Whether a Source line describes a good or a service.

string

Allowed values: good service

quantity

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

tax

required

discriminator: kind

object

object

included

required

boolean

kind

required

string

Allowed values: itbis_18

object

object

included

required

boolean

kind

required

string

Allowed values: itbis_16

ZeroRatedTax

object

kind

required

string

Allowed values: zero_rated

ExemptTax

object

kind

required

string

Allowed values: exempt

object

object

kind

required

string

Allowed values: non_billable

unit

required

A DGII e-CF unit of measure: a readable lowercase name on the Source and Invoice wire, the official numeric catalog code in fiscal documents.

string

Allowed values: barrel bag jar bundle bottle box cigarette_pack centimetre cylinder set container day dozen bale gallon degree gram bulk hour crate kilogram kilowatt_hour pound litre lot metre square_metre cubic_metre million_btu minute package pair foot piece roll envelope second tank ton tube yard square_yard unit element thousand sack tin display drum ration quintal gross_register_tonnage square_foot passenger inch boat_berth_stay tray hectare millilitre milligram ounce troy_ounce

unitPrice

required

string

/^[0-9]{1,16}(\.[0-9]{1,4})?$/

additionalDescription

null

null

string

string

>= 1 characters <= 1000 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

adjustments

null

null

LinePriceAdjustments

Line-level discounts and surcharges, kept separate from document-level adjustments.

object

discounts

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

surcharges

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

id

null

null

string

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

itemCodes

null

null

Array<object>

Array<object>

0 <= 5 items

object

code

required

string

>= 1 characters <= 35 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

typeCode

required

string

>= 1 characters <= 14 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

legalTip

boolean | null

paymentTerms

required

discriminator: type

object

object

type

required

string

Allowed values: immediate

allocations

null

null

Array<object>

Array<object>

>= 1 items <= 7 items

One payment method and its amount, in DOP whatever the Invoice’s currency. The allocations sum to the DOP total.

object

amount

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

method

required

Named payment methods whose official codes are owned by fiscal-document.

string

Allowed values: cash bank_transfer card credit_sale gift_certificate barter credit_note other

paymentAccount

object

accountNumber

null

null

string

string

>= 1 characters <= 28 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

bankName

null

null

string

string

>= 1 characters <= 75 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

CreditPaymentTerms

object

dueOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

type

required

string

Allowed values: credit

FreePaymentTerms

object

type

required

string

Allowed values: free

type

required

string

Allowed values: E32

Optional fields

additionalInformation

null

null

InvoiceAdditionalInformation

object

referenceNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

shipment

object

containerNumber

null

null

string

string

>= 1 characters <= 100 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryNoteNumber

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

driver

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

grossWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

grossWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

netWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

netWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageCount

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

packageUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageVolume

null

null

string

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

route

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

shipmentDate

null

null

string

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

shipmentNumber

null

null

string

string

>= 1 characters <= 25 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

transportDocumentNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

transportZone

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehicleFiche

null

null

string

string

>= 1 characters <= 10 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehiclePlate

null

null

string

string

>= 1 characters <= 7 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

volumeUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

buyer

null

null

InvoiceConsumerBuyer

discriminator: kind

DomesticInvoiceBuyer

object

kind

required

string

Allowed values: domestic

legalName

required

string

>= 1 characters <= 150 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

taxId

required

string

/^[0-9]{9}([0-9]{2})?$/

deliveryPhone

null

null

string

string

/^[0-9]{3}-[0-9]{3}-[0-9]{4}$/

ForeignBuyer

object

foreignId

required

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

string

Allowed values: foreign

legalName

required

string

>= 1 characters <= 150 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryPhone

null

null

string

string

/^[0-9]{3}-[0-9]{3}-[0-9]{4}$/

exchangeRate

null

null

InvoiceExchangeRate

The exchange rate of record: DOP per one unit of the Invoice’s currency.

object

rate

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

expectedTotals

null

null

InvoiceExpectedTotals

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

nonBillable

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

fiscal

null

null

InvoiceFiscalExpectedTotals

DOP accounting assertions against the e-CF’s MontoTotal and its parts.

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

incomeType

null

null

string

string

Allowed values: 01 02 03 04 05 06

numbering

null

null

InvoiceNumbering

object

eNcf

required

string

/^E(31|32|33|34|41|43|44|45|46|47)[0-9]{10}$/

sequenceExpiresOn

string | null

pdfLayout

null

null

InvoicePdfLayout

string

Allowed values: a4 receipt80mm

referenceInformation

null

null

InvoiceReferenceInformation

object

attribution

required

discriminator: kind

InternalOperationReference

object

fiscalOperationId

required

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

kind

required

string

Allowed values: internal_operation

object

object

environment

required

DGII execution environment selected before lifecycle admission.

string

Allowed values: sandbox certification production

issuerTaxId

required

string

/^[0-9]{9}([0-9]{2})?$/

kind

required

string

Allowed values: external_document

sourceReference

required

string

>= 1 characters <= 250 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

fiscalNumber

required

string

/^(B[0-9]{10}|E[0-9]{12}|[AP][0-9]{18})$/

issuedOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

modificationCode

required

string

Allowed values: 4 5

source

null

null

InvoiceSourceInput

object

id

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

version

required

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

InvoiceRequestE41

object

currency

required

string

Allowed values: DOP BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

invoiceReference

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

items

required

Array<object>

>= 1 items <= 1000 items

object

description

required

string

>= 1 characters <= 80 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

Whether a Source line describes a good or a service.

string

Allowed values: good service

quantity

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

tax

required

discriminator: kind

object

object

kind

required

string

Allowed values: itbis_18

object

object

kind

required

string

Allowed values: itbis_16

ZeroRatedTax

object

kind

required

string

Allowed values: zero_rated

ExemptTax

object

kind

required

string

Allowed values: exempt

unit

required

A DGII e-CF unit of measure: a readable lowercase name on the Source and Invoice wire, the official numeric catalog code in fiscal documents.

string

Allowed values: barrel bag jar bundle bottle box cigarette_pack centimetre cylinder set container day dozen bale gallon degree gram bulk hour crate kilogram kilowatt_hour pound litre lot metre square_metre cubic_metre million_btu minute package pair foot piece roll envelope second tank ton tube yard square_yard unit element thousand sack tin display drum ration quintal gross_register_tonnage square_foot passenger inch boat_berth_stay tray hectare millilitre milligram ounce troy_ounce

unitPrice

required

string

/^[0-9]{1,16}(\.[0-9]{1,4})?$/

additionalDescription

null

null

string

string

>= 1 characters <= 1000 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

adjustments

null

null

LinePriceAdjustments

Line-level discounts and surcharges, kept separate from document-level adjustments.

object

discounts

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

surcharges

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

id

null

null

string

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

itemCodes

null

null

Array<object>

Array<object>

0 <= 5 items

object

code

required

string

>= 1 characters <= 35 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

typeCode

required

string

>= 1 characters <= 14 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

withholding

null

null

InvoicePurchaseWithholding

ITBIS and income tax withheld on one item, in DOP whatever the Invoice’s currency.

object

incomeTaxAmount

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

itbisAmount

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

paymentTerms

required

discriminator: type

object

object

type

required

string

Allowed values: immediate

allocations

null

null

Array<object>

Array<object>

>= 1 items <= 7 items

One payment method and its amount, in DOP whatever the Invoice’s currency. The allocations sum to the DOP total.

object

amount

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

method

required

Named payment methods whose official codes are owned by fiscal-document.

string

Allowed values: cash bank_transfer card credit_sale gift_certificate barter credit_note other

paymentAccount

object

accountNumber

null

null

string

string

>= 1 characters <= 28 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

bankName

null

null

string

string

>= 1 characters <= 75 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

CreditPaymentTerms

object

dueOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

type

required

string

Allowed values: credit

FreePaymentTerms

object

type

required

string

Allowed values: free

supplier

required

object

legalName

required

string

>= 1 characters <= 150 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

taxId

required

string

/^[0-9]{9}([0-9]{2})?$/

address

null

null

string

string

>= 1 characters <= 100 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

contactName

null

null

string

string

>= 1 characters <= 80 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

email

null

null

string

string

<= 80 characters /^[\p{L}\p{M}\p{N}\p{S}_]+(?:[-.][\p{L}\p{M}\p{N}\p{S}_]+)*@[\p{L}\p{M}\p{N}\p{S}]+(?:[-.][\p{L}\p{M}\p{N}\p{S}]+)*\.[\p{L}\p{M}\p{N}\p{S}]+(?:[-.][\p{L}\p{M}\p{N}\p{S}]+)*$/

internalCode

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

municipalityCode

null

null

string

string

/^[0-9]{6}$/

Allowed values: 010000 010100 010101 020000 020100 020101 020102 020103 020104 020105 020106 020107 020108 020109 020200 020201 020202 020300 020301 020302 020303 020400 020401 020402 020403 020404 020405 020500 020501 020600 020601 020602 020603 020604 020700 020701 020702 020800 020801 020802 020803 020804 020900 020901 021000 021001 030000 030001 030101 030102 030200 030201 030202 030300 030301 030302 030303 030304 030305 030306 030307 030400 030401 030500 030501 030502 040000 040100 040101 040102 040103 040104 040200 040201 040300 040301 040302 040400 040401 040402 040500 040501 040502 040503 040504 040600 040601 040700 040701 040702 040800 040801 040802 040900 040901 041000 041001 041100 041101 041102 050000 050100 050101 050102 050200 050201 050202 050203 050300 050301 050400 050401 050500 050501 050502 060000 060100 060101 060102 060103 060104 060105 060200 060201 060202 060203 060300 060301 060400 060401 060500 060501 060502 060503 060504 060505 060600 060601 060700 060701 060702 070000 070100 070101 070102 070103 070200 070201 070202 070203 070300 070301 070302 070400 070401 070402 070500 070501 070502 070600 070601 080000 080100 080101 080102 080103 080104 080200 080201 080202 080203 090000 090100 090101 090102 090103 090104 090105 090106 090107 090108 090109 090200 090201 090300 090301 090302 090303 090304 090400 090401 100000 100100 100101 100102 100103 100200 100201 100202 100300 100301 100400 100401 100402 100500 100501 100502 100600 100601 100602 110000 110100 110101 110102 110103 110104 110200 110201 110202 110203 120000 120100 120101 120102 120200 120201 120300 120301 120302 130000 130100 130101 130102 130103 130104 130105 130200 130201 130202 130203 130300 130301 130302 130303 130400 130401 130402 140000 140100 140101 140102 140103 140104 140200 140201 140202 140203 140300 140301 140302 140400 140401 150000 150100 150101 150200 150201 150202 150300 150301 150302 150303 150304 150400 150401 150500 150501 150502 150600 150601 160000 160100 160101 160102 160200 160201 160202 170000 170100 170101 170102 170103 170104 170105 170106 170107 170108 170109 170110 170200 170201 170202 170203 170300 170301 180000 180100 180101 180102 180103 180200 180201 180202 180300 180301 180400 180401 180500 180501 180502 180600 180601 180602 180603 180604 180700 180701 180702 180703 180800 180801 180802 180803 180804 180900 180901 190000 190100 190101 190102 190200 190201 190202 190300 190301 200000 200100 200101 200102 200103 200104 200200 200201 200300 200301 210000 210100 210101 210102 210103 210200 210201 210300 210301 210302 210303 210400 210401 210402 210500 210501 210502 210503 210504 210600 210601 210602 210700 210701 210800 210801 220000 220100 220101 220102 220103 220104 220105 220106 220107 220108 220109 220110 220111 220200 220201 220202 220203 220300 220301 220302 220303 220400 220401 220402 220500 220501 220502 220503 220600 220601 220602 230000 230100 230101 230200 230201 230202 230203 230300 230301 230400 230401 230500 230501 230600 230601 240000 240100 240101 240102 240103 240104 240105 240106 240200 240201 240202 240300 240301 240400 240401 240402 240403 240404 250000 250100 250101 250102 250104 250105 250106 250107 250200 250201 250300 250301 250302 250303 250400 250401 250402 250500 250501 250502 250503 250504 250600 250601 250602 250700 250701 250702 250703 250800 250801 250802 250803 250900 250901 251000 251001 260000 260100 260101 260200 260201 260300 260301 270000 270100 270101 270102 270103 270104 270200 270201 270202 270203 270204 270205 270300 270301 270302 270303 270304 280000 280100 280101 280102 280103 280104 280105 280106 280200 280201 280300 280301 280302 280303 290000 290100 290101 290102 290103 290104 290200 290201 290300 290301 290302 290303 290400 290402 290403 290500 290501 300000 300100 300101 300102 300103 300104 300200 300201 300202 300300 300301 310000 310100 310101 310102 310103 310104 310105 310200 310201 310300 310301 320000 320100 320101 320102 320200 320201 320300 320301 320302 320400 320401 320402 320500 320501 320502 320600 320601 320602 320603 320700 320701 320702 320703

provinceCode

null

null

string

string

/^[0-9]{6}$/

Allowed values: 010000 010100 010101 020000 020100 020101 020102 020103 020104 020105 020106 020107 020108 020109 020200 020201 020202 020300 020301 020302 020303 020400 020401 020402 020403 020404 020405 020500 020501 020600 020601 020602 020603 020604 020700 020701 020702 020800 020801 020802 020803 020804 020900 020901 021000 021001 030000 030001 030101 030102 030200 030201 030202 030300 030301 030302 030303 030304 030305 030306 030307 030400 030401 030500 030501 030502 040000 040100 040101 040102 040103 040104 040200 040201 040300 040301 040302 040400 040401 040402 040500 040501 040502 040503 040504 040600 040601 040700 040701 040702 040800 040801 040802 040900 040901 041000 041001 041100 041101 041102 050000 050100 050101 050102 050200 050201 050202 050203 050300 050301 050400 050401 050500 050501 050502 060000 060100 060101 060102 060103 060104 060105 060200 060201 060202 060203 060300 060301 060400 060401 060500 060501 060502 060503 060504 060505 060600 060601 060700 060701 060702 070000 070100 070101 070102 070103 070200 070201 070202 070203 070300 070301 070302 070400 070401 070402 070500 070501 070502 070600 070601 080000 080100 080101 080102 080103 080104 080200 080201 080202 080203 090000 090100 090101 090102 090103 090104 090105 090106 090107 090108 090109 090200 090201 090300 090301 090302 090303 090304 090400 090401 100000 100100 100101 100102 100103 100200 100201 100202 100300 100301 100400 100401 100402 100500 100501 100502 100600 100601 100602 110000 110100 110101 110102 110103 110104 110200 110201 110202 110203 120000 120100 120101 120102 120200 120201 120300 120301 120302 130000 130100 130101 130102 130103 130104 130105 130200 130201 130202 130203 130300 130301 130302 130303 130400 130401 130402 140000 140100 140101 140102 140103 140104 140200 140201 140202 140203 140300 140301 140302 140400 140401 150000 150100 150101 150200 150201 150202 150300 150301 150302 150303 150304 150400 150401 150500 150501 150502 150600 150601 160000 160100 160101 160102 160200 160201 160202 170000 170100 170101 170102 170103 170104 170105 170106 170107 170108 170109 170110 170200 170201 170202 170203 170300 170301 180000 180100 180101 180102 180103 180200 180201 180202 180300 180301 180400 180401 180500 180501 180502 180600 180601 180602 180603 180604 180700 180701 180702 180703 180800 180801 180802 180803 180804 180900 180901 190000 190100 190101 190102 190200 190201 190202 190300 190301 200000 200100 200101 200102 200103 200104 200200 200201 200300 200301 210000 210100 210101 210102 210103 210200 210201 210300 210301 210302 210303 210400 210401 210402 210500 210501 210502 210503 210504 210600 210601 210602 210700 210701 210800 210801 220000 220100 220101 220102 220103 220104 220105 220106 220107 220108 220109 220110 220111 220200 220201 220202 220203 220300 220301 220302 220303 220400 220401 220402 220500 220501 220502 220503 220600 220601 220602 230000 230100 230101 230200 230201 230202 230203 230300 230301 230400 230401 230500 230501 230600 230601 240000 240100 240101 240102 240103 240104 240105 240106 240200 240201 240202 240300 240301 240400 240401 240402 240403 240404 250000 250100 250101 250102 250104 250105 250106 250107 250200 250201 250300 250301 250302 250303 250400 250401 250402 250500 250501 250502 250503 250504 250600 250601 250602 250700 250701 250702 250703 250800 250801 250802 250803 250900 250901 251000 251001 260000 260100 260101 260200 260201 260300 260301 270000 270100 270101 270102 270103 270104 270200 270201 270202 270203 270204 270205 270300 270301 270302 270303 270304 280000 280100 280101 280102 280103 280104 280105 280106 280200 280201 280300 280301 280302 280303 290000 290100 290101 290102 290103 290104 290200 290201 290300 290301 290302 290303 290400 290402 290403 290500 290501 300000 300100 300101 300102 300103 300104 300200 300201 300202 300300 300301 310000 310100 310101 310102 310103 310104 310105 310200 310201 310300 310301 320000 320100 320101 320102 320200 320201 320300 320301 320302 320400 320401 320402 320500 320501 320502 320600 320601 320602 320603 320700 320701 320702 320703

type

required

string

Allowed values: E41

Optional fields

additionalInformation

null

null

InvoiceAdditionalInformation

object

referenceNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

shipment

object

containerNumber

null

null

string

string

>= 1 characters <= 100 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryNoteNumber

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

driver

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

grossWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

grossWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

netWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

netWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageCount

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

packageUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageVolume

null

null

string

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

route

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

shipmentDate

null

null

string

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

shipmentNumber

null

null

string

string

>= 1 characters <= 25 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

transportDocumentNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

transportZone

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehicleFiche

null

null

string

string

>= 1 characters <= 10 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehiclePlate

null

null

string

string

>= 1 characters <= 7 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

volumeUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

exchangeRate

null

null

InvoiceExchangeRate

The exchange rate of record: DOP per one unit of the Invoice’s currency.

object

rate

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

expectedTotals

null

null

InvoiceExpectedTotals

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

nonBillable

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

fiscal

null

null

InvoiceFiscalExpectedTotals

DOP accounting assertions against the e-CF’s MontoTotal and its parts.

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

numbering

null

null

InvoiceNumbering

object

eNcf

required

string

/^E(31|32|33|34|41|43|44|45|46|47)[0-9]{10}$/

sequenceExpiresOn

string | null

pdfLayout

null

null

InvoicePdfLayout

string

Allowed values: a4 receipt80mm

referenceInformation

null

null

InvoiceReferenceInformation

object

attribution

required

discriminator: kind

InternalOperationReference

object

fiscalOperationId

required

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

kind

required

string

Allowed values: internal_operation

object

object

environment

required

DGII execution environment selected before lifecycle admission.

string

Allowed values: sandbox certification production

issuerTaxId

required

string

/^[0-9]{9}([0-9]{2})?$/

kind

required

string

Allowed values: external_document

sourceReference

required

string

>= 1 characters <= 250 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

fiscalNumber

required

string

/^(B[0-9]{10}|E[0-9]{12}|[AP][0-9]{18})$/

issuedOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

modificationCode

required

string

Allowed values: 4 5

source

null

null

InvoiceSourceInput

object

id

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

version

required

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

InvoiceRequestE45

object

buyer

required

object

legalName

required

string

>= 1 characters <= 150 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

taxId

required

string

/^[0-9]{9}([0-9]{2})?$/

address

null

null

string

string

>= 1 characters <= 100 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

contactName

null

null

string

string

>= 1 characters <= 80 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryOn

null

null

string

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

deliveryPhone

null

null

string

string

/^[0-9]{3}-[0-9]{3}-[0-9]{4}$/

email

null

null

string

string

<= 80 characters /^[\p{L}\p{M}\p{N}\p{S}_]+(?:[-.][\p{L}\p{M}\p{N}\p{S}_]+)*@[\p{L}\p{M}\p{N}\p{S}]+(?:[-.][\p{L}\p{M}\p{N}\p{S}]+)*\.[\p{L}\p{M}\p{N}\p{S}]+(?:[-.][\p{L}\p{M}\p{N}\p{S}]+)*$/

internalCode

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

municipalityCode

null

null

string

string

/^[0-9]{6}$/

Allowed values: 010000 010100 010101 020000 020100 020101 020102 020103 020104 020105 020106 020107 020108 020109 020200 020201 020202 020300 020301 020302 020303 020400 020401 020402 020403 020404 020405 020500 020501 020600 020601 020602 020603 020604 020700 020701 020702 020800 020801 020802 020803 020804 020900 020901 021000 021001 030000 030001 030101 030102 030200 030201 030202 030300 030301 030302 030303 030304 030305 030306 030307 030400 030401 030500 030501 030502 040000 040100 040101 040102 040103 040104 040200 040201 040300 040301 040302 040400 040401 040402 040500 040501 040502 040503 040504 040600 040601 040700 040701 040702 040800 040801 040802 040900 040901 041000 041001 041100 041101 041102 050000 050100 050101 050102 050200 050201 050202 050203 050300 050301 050400 050401 050500 050501 050502 060000 060100 060101 060102 060103 060104 060105 060200 060201 060202 060203 060300 060301 060400 060401 060500 060501 060502 060503 060504 060505 060600 060601 060700 060701 060702 070000 070100 070101 070102 070103 070200 070201 070202 070203 070300 070301 070302 070400 070401 070402 070500 070501 070502 070600 070601 080000 080100 080101 080102 080103 080104 080200 080201 080202 080203 090000 090100 090101 090102 090103 090104 090105 090106 090107 090108 090109 090200 090201 090300 090301 090302 090303 090304 090400 090401 100000 100100 100101 100102 100103 100200 100201 100202 100300 100301 100400 100401 100402 100500 100501 100502 100600 100601 100602 110000 110100 110101 110102 110103 110104 110200 110201 110202 110203 120000 120100 120101 120102 120200 120201 120300 120301 120302 130000 130100 130101 130102 130103 130104 130105 130200 130201 130202 130203 130300 130301 130302 130303 130400 130401 130402 140000 140100 140101 140102 140103 140104 140200 140201 140202 140203 140300 140301 140302 140400 140401 150000 150100 150101 150200 150201 150202 150300 150301 150302 150303 150304 150400 150401 150500 150501 150502 150600 150601 160000 160100 160101 160102 160200 160201 160202 170000 170100 170101 170102 170103 170104 170105 170106 170107 170108 170109 170110 170200 170201 170202 170203 170300 170301 180000 180100 180101 180102 180103 180200 180201 180202 180300 180301 180400 180401 180500 180501 180502 180600 180601 180602 180603 180604 180700 180701 180702 180703 180800 180801 180802 180803 180804 180900 180901 190000 190100 190101 190102 190200 190201 190202 190300 190301 200000 200100 200101 200102 200103 200104 200200 200201 200300 200301 210000 210100 210101 210102 210103 210200 210201 210300 210301 210302 210303 210400 210401 210402 210500 210501 210502 210503 210504 210600 210601 210602 210700 210701 210800 210801 220000 220100 220101 220102 220103 220104 220105 220106 220107 220108 220109 220110 220111 220200 220201 220202 220203 220300 220301 220302 220303 220400 220401 220402 220500 220501 220502 220503 220600 220601 220602 230000 230100 230101 230200 230201 230202 230203 230300 230301 230400 230401 230500 230501 230600 230601 240000 240100 240101 240102 240103 240104 240105 240106 240200 240201 240202 240300 240301 240400 240401 240402 240403 240404 250000 250100 250101 250102 250104 250105 250106 250107 250200 250201 250300 250301 250302 250303 250400 250401 250402 250500 250501 250502 250503 250504 250600 250601 250602 250700 250701 250702 250703 250800 250801 250802 250803 250900 250901 251000 251001 260000 260100 260101 260200 260201 260300 260301 270000 270100 270101 270102 270103 270104 270200 270201 270202 270203 270204 270205 270300 270301 270302 270303 270304 280000 280100 280101 280102 280103 280104 280105 280106 280200 280201 280300 280301 280302 280303 290000 290100 290101 290102 290103 290104 290200 290201 290300 290301 290302 290303 290400 290402 290403 290500 290501 300000 300100 300101 300102 300103 300104 300200 300201 300202 300300 300301 310000 310100 310101 310102 310103 310104 310105 310200 310201 310300 310301 320000 320100 320101 320102 320200 320201 320300 320301 320302 320400 320401 320402 320500 320501 320502 320600 320601 320602 320603 320700 320701 320702 320703

provinceCode

null

null

string

string

/^[0-9]{6}$/

Allowed values: 010000 010100 010101 020000 020100 020101 020102 020103 020104 020105 020106 020107 020108 020109 020200 020201 020202 020300 020301 020302 020303 020400 020401 020402 020403 020404 020405 020500 020501 020600 020601 020602 020603 020604 020700 020701 020702 020800 020801 020802 020803 020804 020900 020901 021000 021001 030000 030001 030101 030102 030200 030201 030202 030300 030301 030302 030303 030304 030305 030306 030307 030400 030401 030500 030501 030502 040000 040100 040101 040102 040103 040104 040200 040201 040300 040301 040302 040400 040401 040402 040500 040501 040502 040503 040504 040600 040601 040700 040701 040702 040800 040801 040802 040900 040901 041000 041001 041100 041101 041102 050000 050100 050101 050102 050200 050201 050202 050203 050300 050301 050400 050401 050500 050501 050502 060000 060100 060101 060102 060103 060104 060105 060200 060201 060202 060203 060300 060301 060400 060401 060500 060501 060502 060503 060504 060505 060600 060601 060700 060701 060702 070000 070100 070101 070102 070103 070200 070201 070202 070203 070300 070301 070302 070400 070401 070402 070500 070501 070502 070600 070601 080000 080100 080101 080102 080103 080104 080200 080201 080202 080203 090000 090100 090101 090102 090103 090104 090105 090106 090107 090108 090109 090200 090201 090300 090301 090302 090303 090304 090400 090401 100000 100100 100101 100102 100103 100200 100201 100202 100300 100301 100400 100401 100402 100500 100501 100502 100600 100601 100602 110000 110100 110101 110102 110103 110104 110200 110201 110202 110203 120000 120100 120101 120102 120200 120201 120300 120301 120302 130000 130100 130101 130102 130103 130104 130105 130200 130201 130202 130203 130300 130301 130302 130303 130400 130401 130402 140000 140100 140101 140102 140103 140104 140200 140201 140202 140203 140300 140301 140302 140400 140401 150000 150100 150101 150200 150201 150202 150300 150301 150302 150303 150304 150400 150401 150500 150501 150502 150600 150601 160000 160100 160101 160102 160200 160201 160202 170000 170100 170101 170102 170103 170104 170105 170106 170107 170108 170109 170110 170200 170201 170202 170203 170300 170301 180000 180100 180101 180102 180103 180200 180201 180202 180300 180301 180400 180401 180500 180501 180502 180600 180601 180602 180603 180604 180700 180701 180702 180703 180800 180801 180802 180803 180804 180900 180901 190000 190100 190101 190102 190200 190201 190202 190300 190301 200000 200100 200101 200102 200103 200104 200200 200201 200300 200301 210000 210100 210101 210102 210103 210200 210201 210300 210301 210302 210303 210400 210401 210402 210500 210501 210502 210503 210504 210600 210601 210602 210700 210701 210800 210801 220000 220100 220101 220102 220103 220104 220105 220106 220107 220108 220109 220110 220111 220200 220201 220202 220203 220300 220301 220302 220303 220400 220401 220402 220500 220501 220502 220503 220600 220601 220602 230000 230100 230101 230200 230201 230202 230203 230300 230301 230400 230401 230500 230501 230600 230601 240000 240100 240101 240102 240103 240104 240105 240106 240200 240201 240202 240300 240301 240400 240401 240402 240403 240404 250000 250100 250101 250102 250104 250105 250106 250107 250200 250201 250300 250301 250302 250303 250400 250401 250402 250500 250501 250502 250503 250504 250600 250601 250602 250700 250701 250702 250703 250800 250801 250802 250803 250900 250901 251000 251001 260000 260100 260101 260200 260201 260300 260301 270000 270100 270101 270102 270103 270104 270200 270201 270202 270203 270204 270205 270300 270301 270302 270303 270304 280000 280100 280101 280102 280103 280104 280105 280106 280200 280201 280300 280301 280302 280303 290000 290100 290101 290102 290103 290104 290200 290201 290300 290301 290302 290303 290400 290402 290403 290500 290501 300000 300100 300101 300102 300103 300104 300200 300201 300202 300300 300301 310000 310100 310101 310102 310103 310104 310105 310200 310201 310300 310301 320000 320100 320101 320102 320200 320201 320300 320301 320302 320400 320401 320402 320500 320501 320502 320600 320601 320602 320603 320700 320701 320702 320703

purchaseOrderNumber

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

purchaseOrderOn

null

null

string

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

currency

required

string

Allowed values: DOP BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

governmentEligibility

required

discriminator: entityKind

object

object

authorityReference

required

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

entityKind

required

string

Allowed values: central_government

object

object

authorityReference

required

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

entityKind

required

string

Allowed values: decentralized_or_autonomous

object

object

authorityReference

required

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

entityKind

required

string

Allowed values: social_security

object

object

authorityReference

required

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

entityKind

required

string

Allowed values: other_noncommercial_government

invoiceReference

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

items

required

Array<object>

>= 1 items <= 1000 items

object

description

required

string

>= 1 characters <= 80 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

Whether a Source line describes a good or a service.

string

Allowed values: good service

quantity

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

tax

required

discriminator: kind

object

object

included

required

boolean

kind

required

string

Allowed values: itbis_18

object

object

included

required

boolean

kind

required

string

Allowed values: itbis_16

ZeroRatedTax

object

kind

required

string

Allowed values: zero_rated

ExemptTax

object

kind

required

string

Allowed values: exempt

object

object

kind

required

string

Allowed values: non_billable

unit

required

A DGII e-CF unit of measure: a readable lowercase name on the Source and Invoice wire, the official numeric catalog code in fiscal documents.

string

Allowed values: barrel bag jar bundle bottle box cigarette_pack centimetre cylinder set container day dozen bale gallon degree gram bulk hour crate kilogram kilowatt_hour pound litre lot metre square_metre cubic_metre million_btu minute package pair foot piece roll envelope second tank ton tube yard square_yard unit element thousand sack tin display drum ration quintal gross_register_tonnage square_foot passenger inch boat_berth_stay tray hectare millilitre milligram ounce troy_ounce

unitPrice

required

string

/^[0-9]{1,16}(\.[0-9]{1,4})?$/

additionalDescription

null

null

string

string

>= 1 characters <= 1000 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

adjustments

null

null

LinePriceAdjustments

Line-level discounts and surcharges, kept separate from document-level adjustments.

object

discounts

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

surcharges

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

id

null

null

string

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

itemCodes

null

null

Array<object>

Array<object>

0 <= 5 items

object

code

required

string

>= 1 characters <= 35 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

typeCode

required

string

>= 1 characters <= 14 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

legalTip

boolean | null

paymentTerms

required

discriminator: type

object

object

type

required

string

Allowed values: immediate

allocations

null

null

Array<object>

Array<object>

>= 1 items <= 7 items

One payment method and its amount, in DOP whatever the Invoice’s currency. The allocations sum to the DOP total.

object

amount

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

method

required

Named payment methods whose official codes are owned by fiscal-document.

string

Allowed values: cash bank_transfer card credit_sale gift_certificate barter credit_note other

paymentAccount

object

accountNumber

null

null

string

string

>= 1 characters <= 28 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

bankName

null

null

string

string

>= 1 characters <= 75 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

CreditPaymentTerms

object

dueOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

type

required

string

Allowed values: credit

FreePaymentTerms

object

type

required

string

Allowed values: free

type

required

string

Allowed values: E45

Optional fields

additionalInformation

null

null

InvoiceGovernmentAdditionalInformation

object

referenceNumber

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

shipment

object

containerNumber

null

null

string

string

>= 1 characters <= 100 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryNoteNumber

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

driver

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

grossWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

grossWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

netWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

netWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageCount

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

packageUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageVolume

null

null

string

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

route

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

shipmentDate

null

null

string

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

shipmentNumber

null

null

string

string

>= 1 characters <= 25 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

transportDocumentNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

transportZone

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehicleFiche

null

null

string

string

>= 1 characters <= 10 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehiclePlate

null

null

string

string

>= 1 characters <= 7 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

volumeUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

exchangeRate

null

null

InvoiceExchangeRate

The exchange rate of record: DOP per one unit of the Invoice’s currency.

object

rate

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

expectedTotals

null

null

InvoiceExpectedTotals

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

nonBillable

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

fiscal

null

null

InvoiceFiscalExpectedTotals

DOP accounting assertions against the e-CF’s MontoTotal and its parts.

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

incomeType

null

null

string

string

Allowed values: 01 02 03 04 05 06

numbering

null

null

InvoiceNumbering

object

eNcf

required

string

/^E(31|32|33|34|41|43|44|45|46|47)[0-9]{10}$/

sequenceExpiresOn

string | null

pdfLayout

null

null

InvoicePdfLayout

string

Allowed values: a4 receipt80mm

referenceInformation

null

null

InvoiceReferenceInformation

object

attribution

required

discriminator: kind

InternalOperationReference

object

fiscalOperationId

required

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

kind

required

string

Allowed values: internal_operation

object

object

environment

required

DGII execution environment selected before lifecycle admission.

string

Allowed values: sandbox certification production

issuerTaxId

required

string

/^[0-9]{9}([0-9]{2})?$/

kind

required

string

Allowed values: external_document

sourceReference

required

string

>= 1 characters <= 250 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

fiscalNumber

required

string

/^(B[0-9]{10}|E[0-9]{12}|[AP][0-9]{18})$/

issuedOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

modificationCode

required

string

Allowed values: 4 5

source

null

null

InvoiceSourceInput

object

id

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

version

required

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

InvoiceRequestE43

object

currency

required

string

Allowed values: DOP BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

invoiceReference

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

items

required

Array<object>

>= 1 items <= 1000 items

object

description

required

string

>= 1 characters <= 80 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

Whether a Source line describes a good or a service.

string

Allowed values: good service

quantity

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

unit

required

A DGII e-CF unit of measure: a readable lowercase name on the Source and Invoice wire, the official numeric catalog code in fiscal documents.

string

Allowed values: barrel bag jar bundle bottle box cigarette_pack centimetre cylinder set container day dozen bale gallon degree gram bulk hour crate kilogram kilowatt_hour pound litre lot metre square_metre cubic_metre million_btu minute package pair foot piece roll envelope second tank ton tube yard square_yard unit element thousand sack tin display drum ration quintal gross_register_tonnage square_foot passenger inch boat_berth_stay tray hectare millilitre milligram ounce troy_ounce

unitPrice

required

string

/^[0-9]{1,16}(\.[0-9]{1,4})?$/

additionalDescription

null

null

string

string

>= 1 characters <= 1000 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

id

null

null

string

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

itemCodes

null

null

Array<object>

Array<object>

0 <= 5 items

object

code

required

string

>= 1 characters <= 35 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

typeCode

required

string

>= 1 characters <= 14 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

type

required

string

Allowed values: E43

Optional fields

exchangeRate

null

null

InvoiceExchangeRate

The exchange rate of record: DOP per one unit of the Invoice’s currency.

object

rate

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

expectedTotals

null

null

InvoiceExpectedTotals

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

nonBillable

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

fiscal

null

null

InvoiceFiscalExpectedTotals

DOP accounting assertions against the e-CF’s MontoTotal and its parts.

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

numbering

null

null

InvoiceNumbering

object

eNcf

required

string

/^E(31|32|33|34|41|43|44|45|46|47)[0-9]{10}$/

sequenceExpiresOn

string | null

paymentTerms

null

null

InvoiceMinorExpensePaymentTerms

discriminator: type

ImmediatePaymentTerms

object

type

required

string

Allowed values: immediate

FreePaymentTerms

object

type

required

string

Allowed values: free

pdfLayout

null

null

InvoicePdfLayout

string

Allowed values: a4 receipt80mm

referenceInformation

null

null

InvoiceReferenceInformation

object

attribution

required

discriminator: kind

InternalOperationReference

object

fiscalOperationId

required

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

kind

required

string

Allowed values: internal_operation

object

object

environment

required

DGII execution environment selected before lifecycle admission.

string

Allowed values: sandbox certification production

issuerTaxId

required

string

/^[0-9]{9}([0-9]{2})?$/

kind

required

string

Allowed values: external_document

sourceReference

required

string

>= 1 characters <= 250 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

fiscalNumber

required

string

/^(B[0-9]{10}|E[0-9]{12}|[AP][0-9]{18})$/

issuedOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

modificationCode

required

string

Allowed values: 4 5

source

null

null

InvoiceSourceInput

object

id

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

version

required

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

InvoiceRequestE47

object

currency

required

string

Allowed values: DOP BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

foreignPayee

required

object

foreignId

required

string

>= 1 characters <= 20 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

legalName

required

string

>= 1 characters <= 150 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

invoiceReference

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

items

required

Array<object>

>= 1 items <= 1000 items

One Type 47 item. Its incomeTaxWithheld is in DOP whatever the Invoice’s currency.

object

description

required

string

>= 1 characters <= 80 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

incomeTaxWithheld

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

Whether a Source line describes a good or a service.

string

Allowed values: good service

quantity

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

unit

required

A DGII e-CF unit of measure: a readable lowercase name on the Source and Invoice wire, the official numeric catalog code in fiscal documents.

string

Allowed values: barrel bag jar bundle bottle box cigarette_pack centimetre cylinder set container day dozen bale gallon degree gram bulk hour crate kilogram kilowatt_hour pound litre lot metre square_metre cubic_metre million_btu minute package pair foot piece roll envelope second tank ton tube yard square_yard unit element thousand sack tin display drum ration quintal gross_register_tonnage square_foot passenger inch boat_berth_stay tray hectare millilitre milligram ounce troy_ounce

unitPrice

required

string

/^[0-9]{1,16}(\.[0-9]{1,4})?$/

additionalDescription

null

null

string

string

>= 1 characters <= 1000 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

id

null

null

string

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

itemCodes

null

null

Array<object>

Array<object>

0 <= 5 items

object

code

required

string

>= 1 characters <= 35 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

typeCode

required

string

>= 1 characters <= 14 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

type

required

string

Allowed values: E47

withholdingBasis

required

discriminator: basisKind

object

object

authorityReference

required

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

basisKind

required

string

Allowed values: dominican_source_income

Optional fields

exchangeRate

null

null

InvoiceExchangeRate

The exchange rate of record: DOP per one unit of the Invoice’s currency.

object

rate

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

expectedTotals

null

null

InvoiceExpectedTotals

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

nonBillable

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

fiscal

null

null

InvoiceFiscalExpectedTotals

DOP accounting assertions against the e-CF’s MontoTotal and its parts.

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

numbering

null

null

InvoiceNumbering

object

eNcf

required

string

/^E(31|32|33|34|41|43|44|45|46|47)[0-9]{10}$/

sequenceExpiresOn

string | null

paymentTerms

null

null

InvoicePaymentTerms

discriminator: type

object

object

type

required

string

Allowed values: immediate

allocations

null

null

Array<object>

Array<object>

>= 1 items <= 7 items

One payment method and its amount, in DOP whatever the Invoice’s currency. The allocations sum to the DOP total.

object

amount

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

method

required

Named payment methods whose official codes are owned by fiscal-document.

string

Allowed values: cash bank_transfer card credit_sale gift_certificate barter credit_note other

paymentAccount

object

accountNumber

null

null

string

string

>= 1 characters <= 28 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

bankName

null

null

string

string

>= 1 characters <= 75 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

CreditPaymentTerms

object

dueOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

type

required

string

Allowed values: credit

FreePaymentTerms

object

type

required

string

Allowed values: free

pdfLayout

null

null

InvoicePdfLayout

string

Allowed values: a4 receipt80mm

referenceInformation

null

null

InvoiceReferenceInformation

object

attribution

required

discriminator: kind

InternalOperationReference

object

fiscalOperationId

required

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

kind

required

string

Allowed values: internal_operation

object

object

environment

required

DGII execution environment selected before lifecycle admission.

string

Allowed values: sandbox certification production

issuerTaxId

required

string

/^[0-9]{9}([0-9]{2})?$/

kind

required

string

Allowed values: external_document

sourceReference

required

string

>= 1 characters <= 250 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

fiscalNumber

required

string

/^(B[0-9]{10}|E[0-9]{12}|[AP][0-9]{18})$/

issuedOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

modificationCode

required

string

Allowed values: 4 5

source

null

null

InvoiceSourceInput

object

id

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

version

required

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

InvoiceRequestE44

object

buyer

required

discriminator: kind

DomesticInvoiceBuyer

object

kind

required

string

Allowed values: domestic

legalName

required

string

>= 1 characters <= 150 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

taxId

required

string

/^[0-9]{9}([0-9]{2})?$/

deliveryPhone

null

null

string

string

/^[0-9]{3}-[0-9]{3}-[0-9]{4}$/

object

object

foreignId

required

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

string

Allowed values: foreign_diplomat

legalName

required

string

>= 1 characters <= 150 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryPhone

null

null

string

string

/^[0-9]{3}-[0-9]{3}-[0-9]{4}$/

currency

required

string

Allowed values: DOP BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

eligibility

required

discriminator: basisKind

object

object

authorityReference

required

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

basisKind

required

string

Allowed values: special_law

object

object

authorityReference

required

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

basisKind

required

string

Allowed values: ratified_contract

object

object

authorityReference

required

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

basisKind

required

string

Allowed values: ratified_agreement

invoiceReference

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

items

required

Array<object>

>= 1 items <= 1000 items

object

description

required

string

>= 1 characters <= 80 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

Whether a Source line describes a good or a service.

string

Allowed values: good service

quantity

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

unit

required

A DGII e-CF unit of measure: a readable lowercase name on the Source and Invoice wire, the official numeric catalog code in fiscal documents.

string

Allowed values: barrel bag jar bundle bottle box cigarette_pack centimetre cylinder set container day dozen bale gallon degree gram bulk hour crate kilogram kilowatt_hour pound litre lot metre square_metre cubic_metre million_btu minute package pair foot piece roll envelope second tank ton tube yard square_yard unit element thousand sack tin display drum ration quintal gross_register_tonnage square_foot passenger inch boat_berth_stay tray hectare millilitre milligram ounce troy_ounce

unitPrice

required

string

/^[0-9]{1,16}(\.[0-9]{1,4})?$/

additionalDescription

null

null

string

string

>= 1 characters <= 1000 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

additionalTaxCodes

null

null

Array<string>

Array<string>

>= 1 items <= 2 items

Allowed values: 001 002 003 004 005

adjustments

null

null

LinePriceAdjustments

Line-level discounts and surcharges, kept separate from document-level adjustments.

object

discounts

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

surcharges

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

id

null

null

string

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

itemCodes

null

null

Array<object>

Array<object>

0 <= 5 items

object

code

required

string

>= 1 characters <= 35 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

typeCode

required

string

>= 1 characters <= 14 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

paymentTerms

required

discriminator: type

object

object

type

required

string

Allowed values: immediate

allocations

null

null

Array<object>

Array<object>

>= 1 items <= 7 items

One payment method and its amount, in DOP whatever the Invoice’s currency. The allocations sum to the DOP total.

object

amount

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

method

required

Named payment methods whose official codes are owned by fiscal-document.

string

Allowed values: cash bank_transfer card credit_sale gift_certificate barter credit_note other

paymentAccount

object

accountNumber

null

null

string

string

>= 1 characters <= 28 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

bankName

null

null

string

string

>= 1 characters <= 75 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

CreditPaymentTerms

object

dueOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

type

required

string

Allowed values: credit

FreePaymentTerms

object

type

required

string

Allowed values: free

type

required

string

Allowed values: E44

Optional fields

additionalInformation

null

null

InvoiceAdditionalInformation

object

referenceNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

shipment

object

containerNumber

null

null

string

string

>= 1 characters <= 100 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryNoteNumber

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

driver

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

grossWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

grossWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

netWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

netWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageCount

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

packageUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageVolume

null

null

string

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

route

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

shipmentDate

null

null

string

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

shipmentNumber

null

null

string

string

>= 1 characters <= 25 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

transportDocumentNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

transportZone

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehicleFiche

null

null

string

string

>= 1 characters <= 10 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehiclePlate

null

null

string

string

>= 1 characters <= 7 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

volumeUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

exchangeRate

null

null

InvoiceExchangeRate

The exchange rate of record: DOP per one unit of the Invoice’s currency.

object

rate

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

expectedTotals

null

null

InvoiceExpectedTotals

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

nonBillable

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

fiscal

null

null

InvoiceFiscalExpectedTotals

DOP accounting assertions against the e-CF’s MontoTotal and its parts.

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

incomeType

null

null

string

string

Allowed values: 01 02 03 04 05 06

numbering

null

null

InvoiceNumbering

object

eNcf

required

string

/^E(31|32|33|34|41|43|44|45|46|47)[0-9]{10}$/

sequenceExpiresOn

string | null

pdfLayout

null

null

InvoicePdfLayout

string

Allowed values: a4 receipt80mm

referenceInformation

null

null

InvoiceReferenceInformation

object

attribution

required

discriminator: kind

InternalOperationReference

object

fiscalOperationId

required

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

kind

required

string

Allowed values: internal_operation

object

object

environment

required

DGII execution environment selected before lifecycle admission.

string

Allowed values: sandbox certification production

issuerTaxId

required

string

/^[0-9]{9}([0-9]{2})?$/

kind

required

string

Allowed values: external_document

sourceReference

required

string

>= 1 characters <= 250 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

fiscalNumber

required

string

/^(B[0-9]{10}|E[0-9]{12}|[AP][0-9]{18})$/

issuedOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

modificationCode

required

string

Allowed values: 4 5

source

null

null

InvoiceSourceInput

object

id

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

version

required

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

InvoiceRequestE46

object

buyer

required

discriminator: kind

ForeignBuyer

object

foreignId

required

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

string

Allowed values: foreign

legalName

required

string

>= 1 characters <= 150 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryPhone

null

null

string

string

/^[0-9]{3}-[0-9]{3}-[0-9]{4}$/

currency

required

string

Allowed values: DOP BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

eligibility

required

discriminator: exporterKind

object

object

authorityReference

required

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

exporterKind

required

string

Allowed values: national_exporter

object

object

authorityReference

required

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

exporterKind

required

string

Allowed values: free_zone_business

invoiceReference

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

items

required

Array<object>

>= 1 items <= 1000 items

object

description

required

string

>= 1 characters <= 80 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

Whether a Source line describes a good or a service.

string

Allowed values: good service

quantity

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

unit

required

A DGII e-CF unit of measure: a readable lowercase name on the Source and Invoice wire, the official numeric catalog code in fiscal documents.

string

Allowed values: barrel bag jar bundle bottle box cigarette_pack centimetre cylinder set container day dozen bale gallon degree gram bulk hour crate kilogram kilowatt_hour pound litre lot metre square_metre cubic_metre million_btu minute package pair foot piece roll envelope second tank ton tube yard square_yard unit element thousand sack tin display drum ration quintal gross_register_tonnage square_foot passenger inch boat_berth_stay tray hectare millilitre milligram ounce troy_ounce

unitPrice

required

string

/^[0-9]{1,16}(\.[0-9]{1,4})?$/

additionalDescription

null

null

string

string

>= 1 characters <= 1000 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

adjustments

null

null

LinePriceAdjustments

Line-level discounts and surcharges, kept separate from document-level adjustments.

object

discounts

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

surcharges

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

id

null

null

string

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

itemCodes

null

null

Array<object>

Array<object>

0 <= 5 items

object

code

required

string

>= 1 characters <= 35 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

typeCode

required

string

>= 1 characters <= 14 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

paymentTerms

required

discriminator: type

object

object

type

required

string

Allowed values: immediate

allocations

null

null

Array<object>

Array<object>

>= 1 items <= 7 items

One payment method and its amount, in DOP whatever the Invoice’s currency. The allocations sum to the DOP total.

object

amount

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

method

required

Named payment methods whose official codes are owned by fiscal-document.

string

Allowed values: cash bank_transfer card credit_sale gift_certificate barter credit_note other

paymentAccount

object

accountNumber

null

null

string

string

>= 1 characters <= 28 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

bankName

null

null

string

string

>= 1 characters <= 75 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

CreditPaymentTerms

object

dueOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

type

required

string

Allowed values: credit

FreePaymentTerms

object

type

required

string

Allowed values: free

type

required

string

Allowed values: E46

Optional fields

additionalInformation

null

null

InvoiceAdditionalInformation

object

referenceNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

shipment

object

containerNumber

null

null

string

string

>= 1 characters <= 100 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryNoteNumber

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

driver

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

grossWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

grossWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

netWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

netWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageCount

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

packageUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageVolume

null

null

string

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

route

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

shipmentDate

null

null

string

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

shipmentNumber

null

null

string

string

>= 1 characters <= 25 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

transportDocumentNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

transportZone

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehicleFiche

null

null

string

string

>= 1 characters <= 10 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehiclePlate

null

null

string

string

>= 1 characters <= 7 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

volumeUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

exchangeRate

null

null

InvoiceExchangeRate

The exchange rate of record: DOP per one unit of the Invoice’s currency.

object

rate

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

expectedTotals

null

null

InvoiceExpectedTotals

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

nonBillable

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

fiscal

null

null

InvoiceFiscalExpectedTotals

DOP accounting assertions against the e-CF’s MontoTotal and its parts.

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

incomeType

null

null

string

string

Allowed values: 01 02 03 04 05 06

numbering

null

null

InvoiceNumbering

object

eNcf

required

string

/^E(31|32|33|34|41|43|44|45|46|47)[0-9]{10}$/

sequenceExpiresOn

string | null

pdfLayout

null

null

InvoicePdfLayout

string

Allowed values: a4 receipt80mm

referenceInformation

null

null

InvoiceReferenceInformation

object

attribution

required

discriminator: kind

InternalOperationReference

object

fiscalOperationId

required

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

kind

required

string

Allowed values: internal_operation

object

object

environment

required

DGII execution environment selected before lifecycle admission.

string

Allowed values: sandbox certification production

issuerTaxId

required

string

/^[0-9]{9}([0-9]{2})?$/

kind

required

string

Allowed values: external_document

sourceReference

required

string

>= 1 characters <= 250 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

fiscalNumber

required

string

/^(B[0-9]{10}|E[0-9]{12}|[AP][0-9]{18})$/

issuedOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

modificationCode

required

string

Allowed values: 4 5

source

null

null

InvoiceSourceInput

object

id

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

version

required

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

InvoiceRequestE33

object

currency

required

string

Allowed values: DOP BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

invoiceReference

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

items

required

Array<object>

>= 1 items <= 1000 items

object

description

required

string

>= 1 characters <= 80 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

Whether a Source line describes a good or a service.

string

Allowed values: good service

quantity

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

tax

required

discriminator: kind

object

object

included

required

boolean

kind

required

string

Allowed values: itbis_18

object

object

included

required

boolean

kind

required

string

Allowed values: itbis_16

ZeroRatedTax

object

kind

required

string

Allowed values: zero_rated

ExemptTax

object

kind

required

string

Allowed values: exempt

object

object

kind

required

string

Allowed values: non_billable

unit

required

A DGII e-CF unit of measure: a readable lowercase name on the Source and Invoice wire, the official numeric catalog code in fiscal documents.

string

Allowed values: barrel bag jar bundle bottle box cigarette_pack centimetre cylinder set container day dozen bale gallon degree gram bulk hour crate kilogram kilowatt_hour pound litre lot metre square_metre cubic_metre million_btu minute package pair foot piece roll envelope second tank ton tube yard square_yard unit element thousand sack tin display drum ration quintal gross_register_tonnage square_foot passenger inch boat_berth_stay tray hectare millilitre milligram ounce troy_ounce

unitPrice

required

string

/^[0-9]{1,16}(\.[0-9]{1,4})?$/

additionalDescription

null

null

string

string

>= 1 characters <= 1000 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

adjustments

null

null

LinePriceAdjustments

Line-level discounts and surcharges, kept separate from document-level adjustments.

object

discounts

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

surcharges

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

id

null

null

string

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

itemCodes

null

null

Array<object>

Array<object>

0 <= 5 items

object

code

required

string

>= 1 characters <= 35 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

typeCode

required

string

>= 1 characters <= 14 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

legalTip

boolean | null

modificationCode

required

string

Allowed values: 2 3

originalInvoiceId

required

The Invoice Timbro issued that this note modifies. The note takes its buyer from that Invoice.

string format: uuid

paymentTerms

required

discriminator: type

object

object

type

required

string

Allowed values: immediate

allocations

null

null

Array<object>

Array<object>

>= 1 items <= 7 items

One payment method and its amount, in DOP whatever the Invoice’s currency. The allocations sum to the DOP total.

object

amount

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

method

required

Named payment methods whose official codes are owned by fiscal-document.

string

Allowed values: cash bank_transfer card credit_sale gift_certificate barter credit_note other

paymentAccount

object

accountNumber

null

null

string

string

>= 1 characters <= 28 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

bankName

null

null

string

string

>= 1 characters <= 75 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

CreditPaymentTerms

object

dueOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

type

required

string

Allowed values: credit

FreePaymentTerms

object

type

required

string

Allowed values: free

reason

required

string

>= 1 characters <= 90 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

type

required

string

Allowed values: E33

Optional fields

additionalInformation

null

null

InvoiceAdditionalInformation

object

referenceNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

shipment

object

containerNumber

null

null

string

string

>= 1 characters <= 100 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryNoteNumber

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

driver

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

grossWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

grossWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

netWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

netWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageCount

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

packageUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageVolume

null

null

string

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

route

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

shipmentDate

null

null

string

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

shipmentNumber

null

null

string

string

>= 1 characters <= 25 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

transportDocumentNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

transportZone

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehicleFiche

null

null

string

string

>= 1 characters <= 10 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehiclePlate

null

null

string

string

>= 1 characters <= 7 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

volumeUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

exchangeRate

null

null

InvoiceExchangeRate

The exchange rate of record: DOP per one unit of the Invoice’s currency.

object

rate

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

expectedTotals

null

null

InvoiceExpectedTotals

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

nonBillable

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

fiscal

null

null

InvoiceFiscalExpectedTotals

DOP accounting assertions against the e-CF’s MontoTotal and its parts.

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

incomeType

null

null

string

string

Allowed values: 01 02 03 04 05 06

numbering

null

null

InvoiceNumbering

object

eNcf

required

string

/^E(31|32|33|34|41|43|44|45|46|47)[0-9]{10}$/

sequenceExpiresOn

string | null

pdfLayout

null

null

InvoicePdfLayout

string

Allowed values: a4 receipt80mm

source

null

null

InvoiceSourceInput

object

id

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

version

required

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

InvoiceRequestE33External

object

currency

required

string

Allowed values: DOP BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

externalOriginal

required

A document issued outside Timbro that a legal note modifies.

fiscalNumber is the original e-NCF (E, the two type digits, and ten digits) or paper NCF (B and ten digits, or A or P and eighteen digits). issuerTaxId is DGII’s RNC Otro Contribuyente and applies only when the original was issued under a different RNC than the note, for example after a merger or split. buyer is the original’s buyer and may be omitted for an anonymous consumer document. total is the original’s total and is required when the original is an e-CF type 32, because DGII requires the buyer’s identity on a note against a type 32 of DOP 250,000.00 or more.

object

fiscalNumber

required

string

/^(B[0-9]{10}|E[0-9]{12}|[AP][0-9]{18})$/

issuedOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

buyer

null

null

InvoiceConsumerBuyer

discriminator: kind

DomesticInvoiceBuyer

object

kind

required

string

Allowed values: domestic

legalName

required

string

>= 1 characters <= 150 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

taxId

required

string

/^[0-9]{9}([0-9]{2})?$/

deliveryPhone

null

null

string

string

/^[0-9]{3}-[0-9]{3}-[0-9]{4}$/

ForeignBuyer

object

foreignId

required

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

string

Allowed values: foreign

legalName

required

string

>= 1 characters <= 150 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryPhone

null

null

string

string

/^[0-9]{3}-[0-9]{3}-[0-9]{4}$/

issuerTaxId

null

null

string

string

/^[0-9]{9}([0-9]{2})?$/

total

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

invoiceReference

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

items

required

Array<object>

>= 1 items <= 1000 items

object

description

required

string

>= 1 characters <= 80 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

Whether a Source line describes a good or a service.

string

Allowed values: good service

quantity

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

tax

required

discriminator: kind

object

object

included

required

boolean

kind

required

string

Allowed values: itbis_18

object

object

included

required

boolean

kind

required

string

Allowed values: itbis_16

ZeroRatedTax

object

kind

required

string

Allowed values: zero_rated

ExemptTax

object

kind

required

string

Allowed values: exempt

object

object

kind

required

string

Allowed values: non_billable

unit

required

A DGII e-CF unit of measure: a readable lowercase name on the Source and Invoice wire, the official numeric catalog code in fiscal documents.

string

Allowed values: barrel bag jar bundle bottle box cigarette_pack centimetre cylinder set container day dozen bale gallon degree gram bulk hour crate kilogram kilowatt_hour pound litre lot metre square_metre cubic_metre million_btu minute package pair foot piece roll envelope second tank ton tube yard square_yard unit element thousand sack tin display drum ration quintal gross_register_tonnage square_foot passenger inch boat_berth_stay tray hectare millilitre milligram ounce troy_ounce

unitPrice

required

string

/^[0-9]{1,16}(\.[0-9]{1,4})?$/

additionalDescription

null

null

string

string

>= 1 characters <= 1000 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

adjustments

null

null

LinePriceAdjustments

Line-level discounts and surcharges, kept separate from document-level adjustments.

object

discounts

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

surcharges

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

id

null

null

string

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

itemCodes

null

null

Array<object>

Array<object>

0 <= 5 items

object

code

required

string

>= 1 characters <= 35 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

typeCode

required

string

>= 1 characters <= 14 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

legalTip

boolean | null

modificationCode

required

string

Allowed values: 2 3

paymentTerms

required

discriminator: type

object

object

type

required

string

Allowed values: immediate

allocations

null

null

Array<object>

Array<object>

>= 1 items <= 7 items

One payment method and its amount, in DOP whatever the Invoice’s currency. The allocations sum to the DOP total.

object

amount

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

method

required

Named payment methods whose official codes are owned by fiscal-document.

string

Allowed values: cash bank_transfer card credit_sale gift_certificate barter credit_note other

paymentAccount

object

accountNumber

null

null

string

string

>= 1 characters <= 28 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

bankName

null

null

string

string

>= 1 characters <= 75 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

CreditPaymentTerms

object

dueOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

type

required

string

Allowed values: credit

FreePaymentTerms

object

type

required

string

Allowed values: free

reason

required

string

>= 1 characters <= 90 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

type

required

string

Allowed values: E33

Optional fields

additionalInformation

null

null

InvoiceAdditionalInformation

object

referenceNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

shipment

object

containerNumber

null

null

string

string

>= 1 characters <= 100 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryNoteNumber

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

driver

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

grossWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

grossWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

netWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

netWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageCount

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

packageUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageVolume

null

null

string

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

route

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

shipmentDate

null

null

string

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

shipmentNumber

null

null

string

string

>= 1 characters <= 25 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

transportDocumentNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

transportZone

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehicleFiche

null

null

string

string

>= 1 characters <= 10 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehiclePlate

null

null

string

string

>= 1 characters <= 7 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

volumeUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

exchangeRate

null

null

InvoiceExchangeRate

The exchange rate of record: DOP per one unit of the Invoice’s currency.

object

rate

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

expectedTotals

null

null

InvoiceExpectedTotals

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

nonBillable

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

fiscal

null

null

InvoiceFiscalExpectedTotals

DOP accounting assertions against the e-CF’s MontoTotal and its parts.

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

incomeType

null

null

string

string

Allowed values: 01 02 03 04 05 06

numbering

null

null

InvoiceNumbering

object

eNcf

required

string

/^E(31|32|33|34|41|43|44|45|46|47)[0-9]{10}$/

sequenceExpiresOn

string | null

pdfLayout

null

null

InvoicePdfLayout

string

Allowed values: a4 receipt80mm

source

null

null

InvoiceSourceInput

object

id

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

version

required

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

InvoiceRequestE34

object

currency

required

string

Allowed values: DOP BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

invoiceReference

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

items

required

Array<object>

>= 1 items <= 10000 items

object

description

required

string

>= 1 characters <= 80 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

Whether a Source line describes a good or a service.

string

Allowed values: good service

quantity

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

tax

required

discriminator: kind

object

object

included

required

boolean

kind

required

string

Allowed values: itbis_18

object

object

included

required

boolean

kind

required

string

Allowed values: itbis_16

ZeroRatedTax

object

kind

required

string

Allowed values: zero_rated

ExemptTax

object

kind

required

string

Allowed values: exempt

object

object

kind

required

string

Allowed values: non_billable

unit

required

A DGII e-CF unit of measure: a readable lowercase name on the Source and Invoice wire, the official numeric catalog code in fiscal documents.

string

Allowed values: barrel bag jar bundle bottle box cigarette_pack centimetre cylinder set container day dozen bale gallon degree gram bulk hour crate kilogram kilowatt_hour pound litre lot metre square_metre cubic_metre million_btu minute package pair foot piece roll envelope second tank ton tube yard square_yard unit element thousand sack tin display drum ration quintal gross_register_tonnage square_foot passenger inch boat_berth_stay tray hectare millilitre milligram ounce troy_ounce

unitPrice

required

string

/^[0-9]{1,16}(\.[0-9]{1,4})?$/

additionalDescription

null

null

string

string

>= 1 characters <= 1000 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

adjustments

null

null

LinePriceAdjustments

Line-level discounts and surcharges, kept separate from document-level adjustments.

object

discounts

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

surcharges

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

id

null

null

string

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

itemCodes

null

null

Array<object>

Array<object>

0 <= 5 items

object

code

required

string

>= 1 characters <= 35 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

typeCode

required

string

>= 1 characters <= 14 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

legalTip

boolean | null

modificationCode

required

string

Allowed values: 1 2 3

originalInvoiceId

required

The Invoice Timbro issued that this note modifies. The note takes its buyer from that Invoice.

string format: uuid

paymentTerms

required

discriminator: type

ImmediatePaymentTerms

object

type

required

string

Allowed values: immediate

CreditPaymentTerms

object

dueOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

type

required

string

Allowed values: credit

FreePaymentTerms

object

type

required

string

Allowed values: free

reason

required

string

>= 1 characters <= 90 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

type

required

string

Allowed values: E34

Optional fields

additionalInformation

null

null

InvoiceAdditionalInformation

object

referenceNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

shipment

object

containerNumber

null

null

string

string

>= 1 characters <= 100 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryNoteNumber

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

driver

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

grossWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

grossWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

netWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

netWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageCount

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

packageUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageVolume

null

null

string

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

route

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

shipmentDate

null

null

string

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

shipmentNumber

null

null

string

string

>= 1 characters <= 25 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

transportDocumentNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

transportZone

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehicleFiche

null

null

string

string

>= 1 characters <= 10 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehiclePlate

null

null

string

string

>= 1 characters <= 7 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

volumeUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

exchangeRate

null

null

InvoiceExchangeRate

The exchange rate of record: DOP per one unit of the Invoice’s currency.

object

rate

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

expectedTotals

null

null

InvoiceExpectedTotals

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

nonBillable

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

fiscal

null

null

InvoiceFiscalExpectedTotals

DOP accounting assertions against the e-CF’s MontoTotal and its parts.

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

incomeType

null

null

string

string

Allowed values: 01 02 03 04 05 06

numbering

null

null

InvoiceNumbering

object

eNcf

required

string

/^E(31|32|33|34|41|43|44|45|46|47)[0-9]{10}$/

sequenceExpiresOn

string | null

pdfLayout

null

null

InvoicePdfLayout

string

Allowed values: a4 receipt80mm

source

null

null

InvoiceSourceInput

object

id

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

version

required

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

InvoiceRequestE34External

object

currency

required

string

Allowed values: DOP BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

externalOriginal

required

A document issued outside Timbro that a legal note modifies.

fiscalNumber is the original e-NCF (E, the two type digits, and ten digits) or paper NCF (B and ten digits, or A or P and eighteen digits). issuerTaxId is DGII’s RNC Otro Contribuyente and applies only when the original was issued under a different RNC than the note, for example after a merger or split. buyer is the original’s buyer and may be omitted for an anonymous consumer document. total is the original’s total and is required when the original is an e-CF type 32, because DGII requires the buyer’s identity on a note against a type 32 of DOP 250,000.00 or more.

object

fiscalNumber

required

string

/^(B[0-9]{10}|E[0-9]{12}|[AP][0-9]{18})$/

issuedOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

buyer

null

null

InvoiceConsumerBuyer

discriminator: kind

DomesticInvoiceBuyer

object

kind

required

string

Allowed values: domestic

legalName

required

string

>= 1 characters <= 150 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

taxId

required

string

/^[0-9]{9}([0-9]{2})?$/

deliveryPhone

null

null

string

string

/^[0-9]{3}-[0-9]{3}-[0-9]{4}$/

ForeignBuyer

object

foreignId

required

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

string

Allowed values: foreign

legalName

required

string

>= 1 characters <= 150 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryPhone

null

null

string

string

/^[0-9]{3}-[0-9]{3}-[0-9]{4}$/

issuerTaxId

null

null

string

string

/^[0-9]{9}([0-9]{2})?$/

total

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

invoiceReference

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

items

required

Array<object>

>= 1 items <= 10000 items

object

description

required

string

>= 1 characters <= 80 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

kind

required

Whether a Source line describes a good or a service.

string

Allowed values: good service

quantity

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

tax

required

discriminator: kind

object

object

included

required

boolean

kind

required

string

Allowed values: itbis_18

object

object

included

required

boolean

kind

required

string

Allowed values: itbis_16

ZeroRatedTax

object

kind

required

string

Allowed values: zero_rated

ExemptTax

object

kind

required

string

Allowed values: exempt

object

object

kind

required

string

Allowed values: non_billable

unit

required

A DGII e-CF unit of measure: a readable lowercase name on the Source and Invoice wire, the official numeric catalog code in fiscal documents.

string

Allowed values: barrel bag jar bundle bottle box cigarette_pack centimetre cylinder set container day dozen bale gallon degree gram bulk hour crate kilogram kilowatt_hour pound litre lot metre square_metre cubic_metre million_btu minute package pair foot piece roll envelope second tank ton tube yard square_yard unit element thousand sack tin display drum ration quintal gross_register_tonnage square_foot passenger inch boat_berth_stay tray hectare millilitre milligram ounce troy_ounce

unitPrice

required

string

/^[0-9]{1,16}(\.[0-9]{1,4})?$/

additionalDescription

null

null

string

string

>= 1 characters <= 1000 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

adjustments

null

null

LinePriceAdjustments

Line-level discounts and surcharges, kept separate from document-level adjustments.

object

discounts

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

surcharges

Array

0 <= 12 items

object

object

amount

required

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

required

string

Allowed values: fixed_amount

object

object

kind

required

string

Allowed values: percentage

percentage

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

id

null

null

string

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

itemCodes

null

null

Array<object>

Array<object>

0 <= 5 items

object

code

required

string

>= 1 characters <= 35 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

typeCode

required

string

>= 1 characters <= 14 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

legalTip

boolean | null

modificationCode

required

string

Allowed values: 1 2 3

paymentTerms

required

discriminator: type

ImmediatePaymentTerms

object

type

required

string

Allowed values: immediate

CreditPaymentTerms

object

dueOn

required

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

type

required

string

Allowed values: credit

FreePaymentTerms

object

type

required

string

Allowed values: free

reason

required

string

>= 1 characters <= 90 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

type

required

string

Allowed values: E34

Optional fields

additionalInformation

null

null

InvoiceAdditionalInformation

object

referenceNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

shipment

object

containerNumber

null

null

string

string

>= 1 characters <= 100 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

deliveryNoteNumber

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

driver

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

grossWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

grossWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

netWeight

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

netWeightUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageCount

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

packageUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

packageVolume

null

null

string

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

route

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

shipmentDate

null

null

string

A calendar date in the public API’s ISO 8601 date form.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

shipmentNumber

null

null

string

string

>= 1 characters <= 25 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

transportDocumentNumber

null

null

string

string

>= 1 characters <= 20 characters /^[0-9]+$/

transportZone

null

null

string

string

>= 1 characters <= 20 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehicleFiche

null

null

string

string

>= 1 characters <= 10 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

vehiclePlate

null

null

string

string

>= 1 characters <= 7 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

volumeUnit

null

null

string

string

/^([1-9]|[1-5][0-9]|6[0-2])$/

exchangeRate

null

null

InvoiceExchangeRate

The exchange rate of record: DOP per one unit of the Invoice’s currency.

object

rate

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

expectedTotals

null

null

InvoiceExpectedTotals

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

nonBillable

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

fiscal

null

null

InvoiceFiscalExpectedTotals

DOP accounting assertions against the e-CF’s MontoTotal and its parts.

object

net

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

tax

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

total

required

string

/^[0-9]{1,16}\.[0-9]{2}$/

incomeType

null

null

string

string

Allowed values: 01 02 03 04 05 06

numbering

null

null

InvoiceNumbering

object

eNcf

required

string

/^E(31|32|33|34|41|43|44|45|46|47)[0-9]{10}$/

sequenceExpiresOn

string | null

pdfLayout

null

null

InvoicePdfLayout

string

Allowed values: a4 receipt80mm

source

null

null

InvoiceSourceInput

object

id

required

The only field a source-system reference travels in, bounded at 128 characters.

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

version

required

string

>= 1 characters <= 128 characters /^[^\p{White_Space}](?:[\s\S]*[^\p{White_Space}])?$/

Responses

200

200

Default Response

Media typeapplication/json

Response fields and codes

discriminator: status

object

object

status

required

string

Allowed values: valid

totals

required

object

foreign

required

null

null

InvoiceForeignTotals

An Invoice’s totals in the currency it is priced in. total equals the price total.

object

currency

required

string

Allowed values: BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

exchangeRate

required

The exchange rate of record: DOP per one unit of the Invoice’s currency.

object

rate

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

net

required

string

/^[0-9]+\.[0-9]{2}$/

tax

required

string

/^[0-9]+\.[0-9]{2}$/

total

required

string

/^[0-9]+\.[0-9]{2}$/

net

required

string

nonBillable

required

string

tax

required

string

total

required

string

object

object

problems

required

Array<object>

One stable public document problem retained for a rejected admission.

object

code

required

string

message

required

string

path

required

string

status

required

string

Allowed values: invalid

totals

required

null

null

InvoiceTotals

object

foreign

required

null

null

InvoiceForeignTotals

An Invoice’s totals in the currency it is priced in. total equals the price total.

object

currency

required

string

Allowed values: BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

exchangeRate

required

The exchange rate of record: DOP per one unit of the Invoice’s currency.

object

rate

required

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

net

required

string

/^[0-9]+\.[0-9]{2}$/

tax

required

string

/^[0-9]+\.[0-9]{2}$/

total

required

string

/^[0-9]+\.[0-9]{2}$/

net

required

string

nonBillable

required

string

tax

required

string

total

required

string

Headers

request-id

required

string

Identifies this request. Quote it when you contact support.

400

400

The request could not be understood.

Media typeapplication/problem+json

Example

{
  "type": "about:blank",
  "title": "The request could not be understood.",
  "status": 400,
  "code": "parameter_missing",
  "requestId": "request_000000000000000000000001"
}

Response fields and codes

RFC 9457 problem details. Every failure of this API is one of these, and each operation narrows code to the subset it can emit.

object

code

required

Stable machine-readable code. Branch on this, never on title.

string

Allowed values: parameter_missing parameter_invalid request_body_malformed custody_certificate_malformed custody_signature_algorithm_unsupported custody_certificate_trust_profile_unsupported custody_certificate_chain_untrusted custody_certificate_purpose_unsupported source_provider_installation_request_invalid missing_idempotency_key invalid_idempotency_key malformed_json invalid_request invoice_original_invalid invalid_collection_query invalid_collection_cursor invalid_replay_scope webhook_destination_not_allowed commercial_response_motive_invalid

requestId

required

string

status

required

integer format: int32

>= 400 <= 599

Allowed value: 400

title

required

string

type

required

string

Allowed values: about:blank

Optional fields

detail

string

invoiceId

Present only when the rejected request produced a Fiscal operation.

string

issuanceBlockers

Present only when the authoritative issuance rules refused to issue.

Array<string>

Allowed values: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Present only when the rejection points at a value the request carried.

Array<object>

One stable public document problem retained for a rejected admission.

object

code

required

string

message

required

string

path

required

string

Headers

request-id

required

string

Identifies this request. Quote it when you contact support.

401

401

The credential is missing, malformed, or no longer valid.

Media typeapplication/problem+json

Example

{
  "type": "about:blank",
  "title": "The credential is missing, malformed, or no longer valid.",
  "status": 401,
  "code": "api_key_missing",
  "requestId": "request_000000000000000000000001"
}

Response fields and codes

RFC 9457 problem details. Every failure of this API is one of these, and each operation narrows code to the subset it can emit.

object

code

required

Stable machine-readable code. Branch on this, never on title.

string

Allowed values: api_key_missing api_key_invalid integration_token_invalid checkout_token_invalid checkout_token_expired unauthenticated invalid_login invalid_credential credential_revoked

requestId

required

string

status

required

integer format: int32

>= 400 <= 599

Allowed value: 401

title

required

string

type

required

string

Allowed values: about:blank

Optional fields

detail

string

invoiceId

Present only when the rejected request produced a Fiscal operation.

string

issuanceBlockers

Present only when the authoritative issuance rules refused to issue.

Array<string>

Allowed values: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Present only when the rejection points at a value the request carried.

Array<object>

One stable public document problem retained for a rejected admission.

object

code

required

string

message

required

string

path

required

string

Headers

request-id

required

string

Identifies this request. Quote it when you contact support.

403

403

The credential is valid but not permitted to perform this operation.

Media typeapplication/problem+json

Example

{
  "type": "about:blank",
  "title": "The credential is valid but not permitted to perform this operation.",
  "status": 403,
  "code": "operation_not_permitted",
  "requestId": "request_000000000000000000000001"
}

Response fields and codes

RFC 9457 problem details. Every failure of this API is one of these, and each operation narrows code to the subset it can emit.

object

code

required

Stable machine-readable code. Branch on this, never on title.

string

Allowed values: operation_not_permitted

requestId

required

string

status

required

integer format: int32

>= 400 <= 599

Allowed value: 403

title

required

string

type

required

string

Allowed values: about:blank

Optional fields

detail

string

invoiceId

Present only when the rejected request produced a Fiscal operation.

string

issuanceBlockers

Present only when the authoritative issuance rules refused to issue.

Array<string>

Allowed values: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Present only when the rejection points at a value the request carried.

Array<object>

One stable public document problem retained for a rejected admission.

object

code

required

string

message

required

string

path

required

string

Headers

request-id

required

string

Identifies this request. Quote it when you contact support.

409

409

The request conflicts with the current state of the resource or with a previous request using the same Idempotency-Key.

Media typeapplication/problem+json

Example

{
  "type": "about:blank",
  "title": "The request conflicts with the current state of the resource or with a previous request using the same Idempotency-Key.",
  "status": 409,
  "code": "webhook_endpoint_deleted",
  "requestId": "request_000000000000000000000001"
}

Response fields and codes

RFC 9457 problem details. Every failure of this API is one of these, and each operation narrows code to the subset it can emit.

object

code

required

Stable machine-readable code. Branch on this, never on title.

string

Allowed values: webhook_endpoint_deleted webhook_endpoint_suspended email_already_registered organization_slug_taken hosted_tenant_conflict legal_issuer_already_registered onboarding_legal_issuer_identity_conflict legal_issuer_profile_incomplete already_a_member certificate_custody_binding_conflict certificate_custody_certificate_not_active certificate_custody_certificate_version_not_active integration_not_connected source_provider_authorization_required source_provider_installation_disabled source_provider_installation_removed source_provider_scope_insufficient source_provider_target_access_removed source_provider_authorization_conflict source_provider_installation_callback_replayed integration_creation_conflict integration_activation_conflict integration_activation_verification_rejected certification_environment_required certification_test_set_required certification_test_run_in_progress idempotency_key_conflict fiscal_number_already_used sequence_changed sequence_source_record_conflict source_version_stale source_predecessor_conflict source_history_requires_reconciliation source_content_conflict source_action_conflict source_command_conflict invoice_reference_conflict invoice_totals_mismatch printed_representation_profile_conflict source_record_already_fiscalized source_operation_pending source_outcome_unknown authority_rejected_replacement fiscal_operation_not_in_intervention intervention_not_resumable intervention_not_closable correction_target_unsettled correction_target_closed invoice_receipt_not_ready fiscal_delivery_outcome_conflict webhook_endpoint_registration_conflict commercial_response_decision_conflict receiving_issuer_held_elsewhere production_reception_certificate_required production_reception_integration_required production_reception_already_filed

requestId

required

string

status

required

integer format: int32

>= 400 <= 599

Allowed value: 409

title

required

string

type

required

string

Allowed values: about:blank

Optional fields

detail

string

invoiceId

Present only when the rejected request produced a Fiscal operation.

string

issuanceBlockers

Present only when the authoritative issuance rules refused to issue.

Array<string>

Allowed values: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Present only when the rejection points at a value the request carried.

Array<object>

One stable public document problem retained for a rejected admission.

object

code

required

string

message

required

string

path

required

string

Headers

request-id

required

string

Identifies this request. Quote it when you contact support.

413

413

The request body is larger than this endpoint accepts.

Media typeapplication/problem+json

Example

{
  "type": "about:blank",
  "title": "The request body is larger than this endpoint accepts.",
  "status": 413,
  "code": "request_body_too_large",
  "requestId": "request_000000000000000000000001"
}

Response fields and codes

RFC 9457 problem details. Every failure of this API is one of these, and each operation narrows code to the subset it can emit.

object

code

required

Stable machine-readable code. Branch on this, never on title.

string

Allowed values: request_body_too_large request_too_large

requestId

required

string

status

required

integer format: int32

>= 400 <= 599

Allowed value: 413

title

required

string

type

required

string

Allowed values: about:blank

Optional fields

detail

string

invoiceId

Present only when the rejected request produced a Fiscal operation.

string

issuanceBlockers

Present only when the authoritative issuance rules refused to issue.

Array<string>

Allowed values: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Present only when the rejection points at a value the request carried.

Array<object>

One stable public document problem retained for a rejected admission.

object

code

required

string

message

required

string

path

required

string

Headers

request-id

required

string

Identifies this request. Quote it when you contact support.

415

415

The request body carries a content type this endpoint does not accept.

Media typeapplication/problem+json

Example

{
  "type": "about:blank",
  "title": "The request body carries a content type this endpoint does not accept.",
  "status": 415,
  "code": "unsupported_media_type",
  "requestId": "request_000000000000000000000001"
}

Response fields and codes

RFC 9457 problem details. Every failure of this API is one of these, and each operation narrows code to the subset it can emit.

object

code

required

Stable machine-readable code. Branch on this, never on title.

string

Allowed values: unsupported_media_type

requestId

required

string

status

required

integer format: int32

>= 400 <= 599

Allowed value: 415

title

required

string

type

required

string

Allowed values: about:blank

Optional fields

detail

string

invoiceId

Present only when the rejected request produced a Fiscal operation.

string

issuanceBlockers

Present only when the authoritative issuance rules refused to issue.

Array<string>

Allowed values: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Present only when the rejection points at a value the request carried.

Array<object>

One stable public document problem retained for a rejected admission.

object

code

required

string

message

required

string

path

required

string

Headers

request-id

required

string

Identifies this request. Quote it when you contact support.

500

500

The request could not complete. Recover by the retained resource reference or retry with the same command identity.

Media typeapplication/problem+json

Example

{
  "type": "about:blank",
  "title": "The request could not complete. Recover by the retained resource reference or retry with the same command identity.",
  "status": 500,
  "code": "internal_error",
  "requestId": "request_000000000000000000000001"
}

Response fields and codes

RFC 9457 problem details. Every failure of this API is one of these, and each operation narrows code to the subset it can emit.

object

code

required

Stable machine-readable code. Branch on this, never on title.

string

Allowed values: internal_error fiscal_artifact_unverified

requestId

required

string

status

required

integer format: int32

>= 400 <= 599

Allowed value: 500

title

required

string

type

required

string

Allowed values: about:blank

Optional fields

detail

string

invoiceId

Present only when the rejected request produced a Fiscal operation.

string

issuanceBlockers

Present only when the authoritative issuance rules refused to issue.

Array<string>

Allowed values: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Present only when the rejection points at a value the request carried.

Array<object>

One stable public document problem retained for a rejected admission.

object

code

required

string

message

required

string

path

required

string

Headers

request-id

required

string

Identifies this request. Quote it when you contact support.

503

503

A required service is temporarily unavailable. Retry with the same reference or command identity.

Media typeapplication/problem+json

Example

{
  "type": "about:blank",
  "title": "A required service is temporarily unavailable. Retry with the same reference or command identity.",
  "status": 503,
  "code": "integration_authorization_unavailable",
  "requestId": "request_000000000000000000000001"
}

Response fields and codes

RFC 9457 problem details. Every failure of this API is one of these, and each operation narrows code to the subset it can emit.

object

code

required

Stable machine-readable code. Branch on this, never on title.

string

Allowed values: integration_authorization_unavailable

requestId

required

string

status

required

integer format: int32

>= 400 <= 599

Allowed value: 503

title

required

string

type

required

string

Allowed values: about:blank

Optional fields

detail

string

invoiceId

Present only when the rejected request produced a Fiscal operation.

string

issuanceBlockers

Present only when the authoritative issuance rules refused to issue.

Array<string>

Allowed values: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Present only when the rejection points at a value the request carried.

Array<object>

One stable public document problem retained for a rejected admission.

object

code

required

string

message

required

string

path

required

string

Headers

request-id

required

string

Identifies this request. Quote it when you contact support.

Retry-After

string

/^[0-9]+$/

Seconds to wait before repeating this request or reading the resource again.