# Premium Invoices ## List Invoices to be Generated - [GET /list-generate-bill/{invoiceDate}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/listpreminvoicegenerate.md): List of Invoices to be generated based on the selected Invoice Date. ## List Self-Admin Invoices to be Generated - [GET /list-generate-self-admin/{invoiceDate}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/listpreminvoicegenerateselfadmin.md): List of Self-Admin Invoices to be generated based on the selected Invoice Date. ## Generate Subscriber Invoice - [POST /generate-subscriber-invoice](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/generatepreminvoicesubscriber.md): Creates a new Premium Billing Invoice for the selected Subscriber. ## Generate Group Invoice - [POST /generate-group-invoice](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/generatepreminvoicegroup.md): Creates a new Premium Billing Invoice for the selected Group. ## Generate Division Invoice - [POST /generate-division-invoice](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/generatepreminvoicedivision.md): Creates a new Premium Billing Invoice for the selected Group/Division. ## Generate GroupDivisionCaptive Invoice - [POST /generate-group-division-captive-invoice](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/generatepreminvoicegroupdivisioncaptive.md): Creates a new Premium Billing Invoice for the selected GroupDivisionCaptive. ## Generate Group and Division Invoice - [POST /generate-group-division-invoice](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/generatepreminvoicegroupdivision.md): Creates a new Premium Billing Invoice the selected Group for any Division with the Group Invoice Level AND a separate Invoice for each Division flagged as Division Invoice Level. ## Generate Self-Admin Group Invoice - [POST /generate-self-admin-group-invoice](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/generatepreminvoiceselfadmingroup.md): Creates a new Self-Admin Invoice for the selected Group. ## Generate Self-Admin Division Invoice - [POST /generate-self-admin-division-invoice](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/generatepreminvoiceselfadmindivision.md): Creates a new Self-Admin Invoice for the selected Group/Division. ## Reset Self-Admin Invoice - [POST /reset-self-admin-invoice/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/resetselfadmininvoice.md): Reset a Self-Admin Invoice removing received amounts, adjustments applied, etc. ## Clear Applied on Invoice - [POST /invoice-clear-applied/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/invoiceclearapplied.md): Clear Applied data on invoice. Delete received records. Update Received Amounts. ## Delete an Invoice with additional options - [POST /invoice-full-delete/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/fulldeleteinvoice.md): This process will delete an invoice and remove attached records, update or delete adjustments based on selected options. ## Regenerate Invoice - [POST /invoice-regenerate/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/regenerateinvoice.md): This will delete the invoice, remove attached adjustments, payments, etc. Then Regenerate the Invoice using the same Invoice Key. ## Finalize Invoice - [POST /invoice-finalize/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/finalizeinvoice.md): This will finalize the selected Invoice. ## PremInvoice Apply Payments for Self-Admin - [POST /premium-invoice-apply-payment-self-admin](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/preminvoiceapplypaymentselfadmin.md): PremInvoice Apply Payments for Self-Admin ## Set Paid Through by Invoice - [POST /set-paid-through-by-invoice/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/setpaidthroughbyinvoice.md): Updates Paid Through information for enrollments, groups, policies, etc. based on a selected Invoice Key. ## Check Past Due settings and trigger Process Automation - [POST /billing-past-due-process-automation](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/billingpastdueprocessautomation.md): Based on configured Past Due settings, interrogate Premium Billing invoices for past due invoices and fire configured process automation triggers. ## PremInvoice Apply Payments by Subscriber - [POST /premium-invoice-apply-payment-sub](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/preminvoiceapplypaymentsubscriber.md): PremInvoice Apply Payments by Subscriber ## PremInvoice Apply Payments by Header Adjustment - [POST /premium-invoice-apply-payment-adj](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/preminvoiceapplypaymentheaderadjustment.md): PremInvoice Apply Payments by Header Adjustment ## PremInvoice Apply Payments by Subscriber and Plan Type - [POST /premium-invoice-apply-payment-sub-plan-type](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/preminvoiceapplypaymentsubscriberplantype.md): PremInvoice Apply Payments by Subscriber and Plan Type ## PremInvoice Apply Payments by Subscriber and Payor ID - [POST /premium-invoice-apply-payment-sub-payor_id](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/preminvoiceapplypaymentsubscriberpayorid.md): PremInvoice Apply Payments by Subscriber and Payor ID ## PremInvoice Auto-Apply - [POST /premium-invoices/{invoiceKey}/auto-apply](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/preminvoiceautoapply.md): Auto-Apply all payements to the selected invoice. ## PremInvoice Auto-Apply for Self-Admin - [POST /premium-invoices/{invoiceKey}/auto-apply-self-admin](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/adv.-billing/preminvoiceautoapplyselfadmin.md): Auto-Apply all payements to the selected Self-Admin invoice. ## List Invoices to be Generated - [GET /list-generate-bill/{invoiceDate}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/listpreminvoicegenerate.md): List of Invoices to be generated based on the selected Invoice Date. ## List Self-Admin Invoices to be Generated - [GET /list-generate-self-admin/{invoiceDate}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/listpreminvoicegenerateselfadmin.md): List of Self-Admin Invoices to be generated based on the selected Invoice Date. ## Generate Subscriber Invoice - [POST /generate-subscriber-invoice](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/generatepreminvoicesubscriber.md): Creates a new Premium Billing Invoice for the selected Subscriber. ## Generate Group Invoice - [POST /generate-group-invoice](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/generatepreminvoicegroup.md): Creates a new Premium Billing Invoice for the selected Group. ## Generate Division Invoice - [POST /generate-division-invoice](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/generatepreminvoicedivision.md): Creates a new Premium Billing Invoice for the selected Group/Division. ## Generate GroupDivisionCaptive Invoice - [POST /generate-group-division-captive-invoice](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/generatepreminvoicegroupdivisioncaptive.md): Creates a new Premium Billing Invoice for the selected GroupDivisionCaptive. ## Generate Group and Division Invoice - [POST /generate-group-division-invoice](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/generatepreminvoicegroupdivision.md): Creates a new Premium Billing Invoice the selected Group for any Division with the Group Invoice Level AND a separate Invoice for each Division flagged as Division Invoice Level. ## Generate Self-Admin Group Invoice - [POST /generate-self-admin-group-invoice](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/generatepreminvoiceselfadmingroup.md): Creates a new Self-Admin Invoice for the selected Group. ## Generate Self-Admin Division Invoice - [POST /generate-self-admin-division-invoice](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/generatepreminvoiceselfadmindivision.md): Creates a new Self-Admin Invoice for the selected Group/Division. ## Reset Self-Admin Invoice - [POST /reset-self-admin-invoice/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/resetselfadmininvoice.md): Reset a Self-Admin Invoice removing received amounts, adjustments applied, etc. ## Clear Applied on Invoice - [POST /invoice-clear-applied/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/invoiceclearapplied.md): Clear Applied data on invoice. Delete received records. Update Received Amounts. ## Delete an Invoice with additional options - [POST /invoice-full-delete/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/fulldeleteinvoice.md): This process will delete an invoice and remove attached records, update or delete adjustments based on selected options. ## Regenerate Invoice - [POST /invoice-regenerate/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/regenerateinvoice.md): This will delete the invoice, remove attached adjustments, payments, etc. Then Regenerate the Invoice using the same Invoice Key. ## Finalize Invoice - [POST /invoice-finalize/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/finalizeinvoice.md): This will finalize the selected Invoice. ## PremInvoice Apply Payments for Self-Admin - [POST /premium-invoice-apply-payment-self-admin](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/preminvoiceapplypaymentselfadmin.md): PremInvoice Apply Payments for Self-Admin ## Set Paid Through by Invoice - [POST /set-paid-through-by-invoice/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/setpaidthroughbyinvoice.md): Updates Paid Through information for enrollments, groups, policies, etc. based on a selected Invoice Key. ## Check Past Due settings and trigger Process Automation - [POST /billing-past-due-process-automation](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/billingpastdueprocessautomation.md): Based on configured Past Due settings, interrogate Premium Billing invoices for past due invoices and fire configured process automation triggers. ## Create PremInvoice - [POST /premium-invoices](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/createpreminvoice.md): Creates a new PremInvoice ## List PremInvoice - [GET /premium-invoices](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/listpreminvoice.md): Lists all PremInvoice. ## List PremInvoiceSlim - [GET /premium-invoices-slim](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/listpreminvoiceslim.md): Gets a 'Slim' list of PremInvoices. The Slim model has a limited subset of fields intended for quick loading. You may provide the GroupID and/or Invoice Year to filter the list to include only those Invoices in which the Group/Invoice Year match an invoice with the same Group/Invoice Year wihtin the PremInvoiceSubscriber and PremInvoiceSelfAdmin tables. ## Get PremInvoice - [GET /premium-invoices/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/getpreminvoice.md): Gets PremInvoice ## Update PremInvoice - [PUT /premium-invoices/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/updatepreminvoice.md): Updates a specific PremInvoice. ## Delete PremInvoice - [DELETE /premium-invoices/{invoiceKey}](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/deletepreminvoice.md): Deletes an PremInvoice ## Create or Update Batch PremInvoice - [PUT /premium-invoices-batch](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/updatebatchpreminvoice.md): Create or Update multiple PremInvoice at once. If the entity exists, it will be updated. If the entity does not exist, it will be created. ## Get PremInvoice Summary - [GET /premium-invoices/{invoiceKey}/summary](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/getpreminvoicesummary.md): Gets PremInvoice Summary for the specified invoice. First PremInvoiceSelfAdmin table is checked for the invoice key, if found the values are aggregated from come from PremInvoiceSelfAdmin; if the invoice key is not found in PremInvoiceSelfAdmin, the PremInvoiceSubscriber table is checked. If not present in either table, an error is returned. ## Get PremInvoice Group Summary - [GET /premium-invoices-group-summary](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/getpreminvoicegroupsummary.md): Gets PremInvoice Summary for the specified group id and invoice year. First PremInvoiceSelfAdmin table is checked for the group id, if found the values are aggregated from come from PremInvoiceSelfAdmin; if the group is not found in PremInvoiceSelfAdmin, the PremInvoiceSubscriber table is checked for this group. If not present in either table, an error is returned. ## PremInvoice Apply Payments by Subscriber - [POST /premium-invoice-apply-payment-sub](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/preminvoiceapplypaymentsubscriber.md): PremInvoice Apply Payments by Subscriber ## PremInvoice Apply Payments by Header Adjustment - [POST /premium-invoice-apply-payment-adj](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/preminvoiceapplypaymentheaderadjustment.md): PremInvoice Apply Payments by Header Adjustment ## PremInvoice Apply Payments by Subscriber and Plan Type - [POST /premium-invoice-apply-payment-sub-plan-type](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/preminvoiceapplypaymentsubscriberplantype.md): PremInvoice Apply Payments by Subscriber and Plan Type ## PremInvoice Apply Payments by Subscriber and Payor ID - [POST /premium-invoice-apply-payment-sub-payor_id](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/preminvoiceapplypaymentsubscriberpayorid.md): PremInvoice Apply Payments by Subscriber and Payor ID ## PremInvoice Auto-Apply - [POST /premium-invoices/{invoiceKey}/auto-apply](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/preminvoiceautoapply.md): Auto-Apply all payements to the selected invoice. ## PremInvoice Auto-Apply for Self-Admin - [POST /premium-invoices/{invoiceKey}/auto-apply-self-admin](https://vbapi-docs.vbasoftware.com/openapi/vbasoftware.api/premium-invoices/preminvoiceautoapplyselfadmin.md): Auto-Apply all payements to the selected Self-Admin invoice.