Digital Invoice Generation

Learn about required fields and additional requirements for digital invoices.

Digital invoicing occurs when a request contains digital line items and invoice generation is available. By default, the service treats line items as physical goods. You can change this behavior using the Product Delivery configuration.

Digital invoices require Vertex Invoice IQ. Vertex for e-Commerce and Vertex for Marketplaces also enable customer location determination, which can be useful for digital transactions.

Request

See Mandatory Fields for more information about required fields, additional requirements, and restrictions. For customization and invoice required fields, see Invoice Generation.

In principle, a digital invoice request will be an INVOICE request with:

FieldValueNotes
customer.administrativeDestinationSee Customer Location Determination.
customer.locationEvidenceSee Customer Location Determination.
customer.taxRegistrations[]See Customer Location Determination.
lineItems[].product.valueThe product taxability driver code configured for digital goods.

Required when the default behavior treats all lineItems as physical goods and no ProductClass taxability driver code is provided.

The service uses this value to treat the lineItem as digital for invoicing, liability determination, and other purposes.

This does not affect taxation because the result depends on how, or whether, the taxability driver code is mapped in Vertex O Series Cloud.

lineItems[].product.productClassThe product class taxability driver code configured for digital goods.As above. Required if no Product taxability driver code is provided.
saleMessageTypeINVOICERequired to trigger invoice generation.
seller.physicalOriginNot required for digital goods and can be omitted.

Response

See Invoice Generation. The response uses the same format.

Example

Example request, given the original transaction:

{
    "currency": {
        "isoCurrencyCodeAlpha": "GBP"
    },
    "customer": {
        // billing address and some additional location evidence
        // no destination, it will be added by location determination mechanism
        "administrativeDestination": {
            "country": "GB",
            "city": "London",
            "streetAddress1": "2301 Renaissance Blvd",
            "postalCode": "NW6 712"
        },
        "locationEvidence": {
            "ipAddress": {
                "value": "86.14.99.80"
            },
            "bin": {
                "value": "111216"
            }
        }
    },
    "deliveryTerm": "SUP",
    "lineItems": [
        {
            "extendedPrice": 100,
            "lineItemDescription": "Streaming Subscription",
            // we're using productClass configured to be treated as digital
            "product": {
                "productClass": "_DIGITAL"
            }
        }
    ],
    "saleMessageType": "INVOICE",
    "seller": {
        // only administrativeOrigin of the seller as physicalOrigin is not 
        // needed for digital
        "administrativeOrigin": {
            "country": "GB",
            "city": "Liverpool",
            "streetAddress1": "123 Sample Road",
            "postalCode": "L6 3AL"
        },
        "company": "test_seller",
        "taxRegistrations": [
            {
                "isoCountryCode": "GB",
                "taxRegistrationNumber": "GB_TAX_NUMBER"
            }
        ]
    },
    "transactionId": "1837128947198712312311",
    "transactionType": "SALE"
}

The response follows the behavior described in Invoice Generation and Customer Location Determination.


Did this page help you?