Create and Send an Invoice Immediately {#invoicing-services-create-send-intro} ============================================================================== Creating and sending an invoice publishes a payable invoice that is automatically emailed to the customer. In addition to the sent email, you can also share the invoice by sending the customer the redirect URL generated in the invoiceInformation.paymentLink response field. **Itemized Invoices** : An invoice can display a single billed amount or list up to 30 billed items. To list the billed items in the invoice, include the items in the request using the line item array fields. An invoice with line items is known as an *itemized* invoice. For more information about how to include line items in your request, see [Including Line Items in an Invoice](/docs/vas/en-us/invoicing/developer/all/rest/invoicing/invoicing-services-intro/invoicing-services-line-items.md ""). **Invoice Numbers** : You can assign a unique invoice number in the invoiceInformation.invoiceNumber request field. The invoice number is required for follow-on API requests and tracking. You should store the invoice number in your system so that you can optimally perform the follow-on requests. If you do not include a unique invoice number when creating an invoice, `Visa Acceptance Solutions` generates a unique invoice number for you in the invoiceInformation.invoiceNumber response field. IMPORTANT You cannot update the invoice number after it is generated. **Installment Payments** : Invoices can be paid in installment payments when these fields and values are included in the request. If an invoice is payable in installments, multiple customers can make payments towards the same invoice. invoiceInformation.allowPartialPayments : Set to `true`. orderInformation.amountDetails.minimumPartialAmount : Set to the minimum amount allowed for a partial payment. **Partner Information** : If your merchant account is associated with a `Visa Acceptance Solutions` partner, you can include your partner solution ID (PSID) in the request message for tracking and reporting purposes. To include your PSID, use the clientReferenceInformation.partner.solutionId request field and set its field value to your PSID. **Alternative Methods to Create an Invoice** : To create a new invoice that is **not** immediately sent in an email to the customer, see [Create an Invoice without Sending it](/docs/vas/en-us/invoicing/developer/all/rest/invoicing/invoicing-services-intro/invoicing-services-create-intro.md ""). To create an invoice **draft** that is not payable or viewable to the customer, see [Create a Draft Invoice](/docs/vas/en-us/invoicing/developer/all/rest/invoicing/invoicing-services-intro/invoicing-services-create-draft-intro.md ""). Endpoint -------- Send an API POST request message to one of these endpoints: **Test:** `POST ``https://apitest.visaacceptance.com``/invoicing/v2/invoices` **Production:** `POST ``https://api.visaacceptance.com``/invoicing/v2/invoices` Successful Response ------------------- A successfully created and sent invoice is indicated by the `SENT` status in the status response field. The response message also includes the newly created invoice's details. Follow-On API Requests ---------------------- After creating an invoice, you can send these follow-on API requests. **Update an Invoice** : To update customer information or item details in an invoice, send an update invoice request. For more information, see [Update an Invoice](/docs/vas/en-us/invoicing/developer/all/rest/invoicing/invoicing-services-intro/invoicing-services-update-intro.md ""). **Cancel an Invoice** : To cancel an invoice, send a cancel invoice request. For more information, see [Cancel an Invoice](/docs/vas/en-us/invoicing/developer/all/rest/invoicing/invoicing-services-intro/invoicing-services-cancel-intro.md ""). **Get Invoice Details** : You can retrieve an invoice's details by sending a get invoice details request. For more information, see [Get Invoice Details](/docs/vas/en-us/invoicing/developer/all/rest/invoicing/invoicing-services-intro/invoicing-services-get-details-intro.md ""). **Get List of Invoices** : After creating multiple invoices, you might want to search for certain invoices. To retrieve a filtered list of invoices, send a get list of invoices request. For more information, see [Get a List of Invoices](/docs/vas/en-us/invoicing/developer/all/rest/invoicing/invoicing-services-intro/invoicing-services-get-list-intro.md ""). Required Fields for Creating and Sending an Invoice {#invoicing-services-create-send-req-fields} ================================================================================================ This section lists the required fields necessary to create and send these types of invoices: * Email invoice * Itemized email invoice Required Fields for an Email Invoice {#invoicing-services-create-send-req-fields_customer-fields} ------------------------------------------------------------------------------------------------- customerInformation.email : customerInformation.name : invoiceInformation.deliveryMode : Set to `email`. invoiceInformation.description : invoiceInformation.dueDate : invoiceInformation.sendImmediately : Set to `true`. orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : Required Fields for an Email Invoice with Line Items {#invoicing-services-create-send-req-fields_line-item-fields} ------------------------------------------------------------------------------------------------------------------ customerInformation.email : customerInformation.name : invoiceInformation.deliveryMode : Set to `email`. invoiceInformation.dueDate : invoiceInformation.sendImmediately : Set to `true`. orderInformation.amountDetails.currency : orderInformation.amountDetails.totalAmount : orderInformation.lineItems\[\].productName : orderInformation.lineItems\[\].productSku : orderInformation.lineItems\[\].quantity : orderInformation.lineItems\[\].totalAmount : orderInformation.lineItems\[\].unitPrice : Optional Fields for Invoice Creation {#invoicing-services-create-send-opt-fields} ================================================================================= You can include these optional fields when sending create invoice requests: clientReferenceInformation.partner.developerId : Set to your developer ID. clientReferenceInformation.partner.solutionId : Set to your partner solution ID (PSID). customerInformation.company.name : customerInformation.email : customerInformation.merchantCustomerId : customerInformation.name : invoiceInformation.allowPartialPayments : Set to one of these possible values: * `false`: The invoice must be paid in a single payment. * `true`: The invoice is payable in installments. invoiceInformation.deliveryMode : invoiceInformation.description : This field is optional when the line item fields are present in the request message. invoiceInformation.invoiceNumber : Set to a unique number to create an invoice number. If you do not include this field and a unique value, the invoicing API automatically generates an invoice number for the new invoice. > IMPORTANT You cannot update this invoice number after sending the API request. merchantDefinedFieldValues.definition id\[\].value : orderInformation.amountDetails.freight.amount : orderInformation.amountDetails.freight.taxable : orderInformation.amountDetails.freight.taxRate : orderInformation.amountDetails.minimumPartialAmount : orderInformation.amountDetails.subAmount : Example: Creating and Sending an Invoice {#invoicing-services-create-send-ex-rest} ================================================================================== Request ``` { "customerInformation": { "email": "test@email.com" }, "invoiceInformation": { "description": "This is a test invoice", "dueDate": "2019-07-11", "sendImmediately": true, "deliveryMode": "email" }, "orderInformation": { "amountDetails": { "totalAmount": "2623.64", "currency": "USD" } } } ``` Response to a Successful Request ```keyword { "_links": { "self": { "href": "/v2/invoices/98768", "method": "GET" }, "update": { "href": "/v2/invoices/98768", "method": "PUT" }, "deliver": { "href": "/v2/invoices/98768/delivery", "method": "POST" }, "cancel": { "href": "/v2/invoices/98768/cancelation", "method": "POST" } }, "id": "98768", "submitTimeUtc": "2024-08-03T00:40:31.143121084Z", "status": "SENT", "customerInformation": { "email": "test@email.com" }, "processingInformation": { "requestPhone": false, "requestShipping": false }, "invoiceInformation": { "invoiceNumber": "98768", "description": "This is a test invoice", "dueDate": "2019-07-11", "allowPartialPayments": false, "paymentLink": "https://businesscenter.visaacceptance.com/ebc2/invoicing/payInvoice/2AgCNHLrUtD7hfFR5SVh5DSxISAbFD9zybhUjpxpZuXKLQVyuLttP78uWWLRSSNX?version=v2.1", "deliveryMode": "Email" }, "orderInformation": { "amountDetails": { "totalAmount": 2623.64, "currency": "USD", "balanceAmount": 2623.64 } } } ``` Request ``` { "customerInformation": { "name": "Tanya Lee", "email": "tanya.lee@my-email.world" }, "invoiceInformation": { "dueDate": "2019-07-11", "sendImmediately": true, "deliveryMode": "email" }, "orderInformation": { "amountDetails": { "totalAmount": 293.5, "currency": "USD" }, "lineItems": [ { "productSku": "P653727383", "productName": "First line item's name", "unitPrice": 12.05, "quantity": 20, "totalAmount": 241 }, { "productSku": "P653727383", "productName": "Second line item's name", "unitPrice": 5.25, "quantity": 10, "totalAmount": 52.5 } ] } } ``` Response to a Successful Request ```keyword { "_links": { "self": { "href": "/v2/invoices/98769", "method": "GET" }, "update": { "href": "/v2/invoices/98769", "method": "PUT" }, "deliver": { "href": "/v2/invoices/98769/delivery", "method": "POST" }, "cancel": { "href": "/v2/invoices/98769/cancelation", "method": "POST" } }, "id": "98769", "submitTimeUtc": "2024-08-03T00:43:05.320320438Z", "status": "SENT", "customerInformation": { "name": "Tanya Lee", "email": "test@email.com" }, "processingInformation": { "requestPhone": false, "requestShipping": false }, "invoiceInformation": { "invoiceNumber": "98769", "dueDate": "2019-07-11", "allowPartialPayments": false, "paymentLink": "https://businesscenter.visaacceptance.com/ebc2/invoicing/payInvoice/XvgrhdaVUbBJb466S9nxqXpp1e2UHoFEUlhye9gtiwgi7gzv5fwqV8YgfP6xep0D?version=v2.1", "deliveryMode": "Email" }, "orderInformation": { "amountDetails": { "totalAmount": 293.5, "currency": "USD", "balanceAmount": 293.5 }, "lineItems": [ { "productSku": "P653727383", "productName": "First line item's name", "unitPrice": 12.05, "quantity": 20, "totalAmount": 241 }, { "productSku": "P653727383", "productName": "Second line item's name", "unitPrice": 5.25, "quantity": 10, "totalAmount": 52.5 } ] } } ``` REST Interactive Example: Create and Send an Invoice {#invoicing-services-create-send-ex-live} ============================================================================================== Click this image to access the interactive code example for creating and sending a new invoice. #### Figure: Interactive Code [![Image and link to the interactive code example for creating a new invoice.](/content/dam/documentation/cybs/en-us/topics/payments-processing/payment-services/invoicing/images/invoicing-services-create-vas.png/jcr:content/renditions/original)](https://developer.visaacceptance.com/api-reference-assets/index.md#invoicing_invoices_create-a-new-invoice "")