{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial","tabs","tab","code-snippet"]},"type":"markdown"},"seo":{"title":"Bill premiums and apply payments"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"bill-premiums-and-apply-payments","__idx":0},"children":["Bill premiums and apply payments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This playbook is for finance and billing teams that want to automate the monthly premium cycle. You generate a group's premium invoice, check its totals, and import a bank payment file (CSV) that creates the payments and posts them to the invoice, without keying payments by hand."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Who this is for"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Premium billing and finance teams, and the developers who automate their bank files"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Time to run"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["About 15 minutes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Writes data?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes. Try it in a non-production database first if you have one. \"Try it\" calls in the API reference are real production calls."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Operations used"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["9, linked in each step"]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"This changes production data"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["VBAPI clients connect to production, so the write calls on this page create or change real records in the database you name in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vbasoftware-database"]},". Try the steps in a non-production database first if VBA has given you one, use clearly fake values while you test, and keep the \"Check it worked\" calls, which only read data. \"Try it\" in the API reference also calls production."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"before-you-start","__idx":1},"children":["Before you start"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You have completed the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/get-started/quick-start"},"children":["quick start"]}," and your environment variables are set."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A test group with enrolled subscribers, premium rates, and a billing cycle already exists. The samples use the fake group ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DOCS-GRP1"]},"; replace it at the top of each sample."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The group is not set up for self-admin billing. Self-admin groups use a different set of operations that this playbook does not cover."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You know the payor and account that payments should be recorded against. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/payor-accounts/listpayoraccount"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /payor-accounts"]}]}," lists each payor with its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account_Key"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A premium payment file format is set up in VBASoftware."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your API user has rights to premium billing and premium payments."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-it-fits-together","__idx":2},"children":["How it fits together"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant App as Your system\n participant API as VBAPI\n App->>API: GET /groups/{groupID}, GET /billing-cycles/{billingCycleID}\n App->>API: POST /generate-group-invoice\n API-->>App: invoice_Key\n App->>API: GET /premium-invoices/{invoiceKey}/summary\n App->>API: GET /premium-payment-file-formats\n App->>API: POST /process-payment-file (base64 CSV)\n API-->>App: payment and invoice counts\n App->>API: GET /premium-invoice-payments-ext/{invoiceKey}\n","diagramHtml":"VBAPIYour systemVBAPIYour systemGET /groups/{groupID}, GET /billing-cycles/{billingCycleID}POST /generate-group-invoiceinvoice_KeyGET /premium-invoices/{invoiceKey}/summaryGET /premium-payment-file-formatsPOST /process-payment-file (base64 CSV)payment and invoice countsGET /premium-invoice-payments-ext/{invoiceKey}","diagramHtmlDark":"VBAPIYour systemVBAPIYour systemGET /groups/{groupID}, GET /billing-cycles/{billingCycleID}POST /generate-group-invoiceinvoice_KeyGET /premium-invoices/{invoiceKey}/summaryGET /premium-payment-file-formatsPOST /process-payment-file (base64 CSV)payment and invoice countsGET /premium-invoice-payments-ext/{invoiceKey}"},"children":["sequenceDiagram\n participant App as Your system\n participant API as VBAPI\n App->>API: GET /groups/{groupID}, GET /billing-cycles/{billingCycleID}\n App->>API: POST /generate-group-invoice\n API-->>App: invoice_Key\n App->>API: GET /premium-invoices/{invoiceKey}/summary\n App->>API: GET /premium-payment-file-formats\n App->>API: POST /process-payment-file (base64 CSV)\n API-->>App: payment and invoice counts\n App->>API: GET /premium-invoice-payments-ext/{invoiceKey}\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"steps","__idx":3},"children":["Steps"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"1-confirm-the-groups-billing-cycle","__idx":4},"children":["1. Confirm the group's billing cycle"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/groups/getgroups"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /groups/{groupID}"]}]},", then ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/billing-cycles/getbillingcycle"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /billing-cycles/{billingCycleID}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The group record says which billing cycle its invoices use (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billing_Cycle_ID"]},") and whether it is a self-admin group (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["self_Admin"]},"). The billing cycle tells you how often the group is billed, so you can pick the right billing period in step 2. To see every cycle, use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/billing-cycles/listbillingcycle"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /billing-cycles"]}]},". Both calls only read data."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/PremiumBillingPlaybook.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" var group = (await api.GetAsync($\"/groups/{GroupId}\")).Data!;\n if (group[\"self_Admin\"]?.GetValue() == true)\n throw new InvalidOperationException($\"{GroupId} uses self-admin billing, which this playbook does not cover.\");\n var cycle = (await api.GetAsync($\"/billing-cycles/{group[\"billing_Cycle_ID\"]}\")).Data!;\n Console.WriteLine($\"Billing cycle: {cycle[\"billing_Cycle_ID\"]} {cycle[\"description\"]}\");\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premium_billing.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" group = api.get(f\"/groups/{GROUP_ID}\").data\n if group[\"self_Admin\"]:\n raise SystemExit(f\"{GROUP_ID} uses self-admin billing, which this playbook does not cover.\")\n cycle = api.get(f\"/billing-cycles/{group['billing_Cycle_ID']}\").data\n print(\"Billing cycle:\", cycle[\"billing_Cycle_ID\"], cycle[\"description\"])\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premiumBilling.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" const group = (await api.get(`/groups/${GROUP_ID}`)).data;\n if (group.self_Admin) throw new Error(`${GROUP_ID} uses self-admin billing, which this playbook does not cover.`);\n const cycle = (await api.get(`/billing-cycles/${group.billing_Cycle_ID}`)).data;\n console.log(\"Billing cycle:\", cycle.billing_Cycle_ID, cycle.description);\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"2-generate-the-group-invoice","__idx":5},"children":["2. Generate the group invoice"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/adv.-billing/generatepreminvoicegroup"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /generate-group-invoice"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This builds one premium invoice for the group for the billing period you give it, and returns it. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GeneratePremInvoice"]}," schema marks no field as required, but the API source (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FABilling/Services/BillingService.cs"]},") rejects a request with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," unless ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["group_ID"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bill_From"]}," are set, and requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["division_ID"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscriber_ID"]}," to be empty for a group invoice. The minimal body:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"group_ID\": \"DOCS-GRP1\",\n \"bill_From\": \"2030-02-01T00:00:00\",\n \"bill_Thru\": \"2030-02-28T00:00:00\",\n \"invoice_Date\": \"2030-01-15T00:00:00\",\n \"due_Date\": \"2030-02-01T00:00:00\",\n \"regenerate\": false\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do not send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["user_ID"]},": VBAPI sets it to the API user. Use the billing period you actually bill; the 2030 dates are placeholders."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/PremiumBillingPlaybook.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" var invoice = (await api.PostAsync(\"/generate-group-invoice\", new\n {\n group_ID = GroupId,\n bill_From = \"2030-02-01T00:00:00\",\n bill_Thru = \"2030-02-28T00:00:00\",\n invoice_Date = \"2030-01-15T00:00:00\",\n due_Date = \"2030-02-01T00:00:00\",\n regenerate = false,\n })).Data!;\n var invoiceKey = invoice[\"invoice_Key\"]!.GetValue();\n Console.WriteLine($\"Invoice {invoiceKey} number {invoice[\"invoice_Number\"]} status {invoice[\"invoice_Status\"]}\");\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premium_billing.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" invoice = api.post(\"/generate-group-invoice\", {\n \"group_ID\": GROUP_ID,\n \"bill_From\": \"2030-02-01T00:00:00\",\n \"bill_Thru\": \"2030-02-28T00:00:00\",\n \"invoice_Date\": \"2030-01-15T00:00:00\",\n \"due_Date\": \"2030-02-01T00:00:00\",\n \"regenerate\": False,\n }).data\n invoice_key = invoice[\"invoice_Key\"]\n print(\"Invoice\", invoice_key, \"number\", invoice[\"invoice_Number\"], \"status\", invoice[\"invoice_Status\"])\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premiumBilling.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" const invoice = (\n await api.post(\"/generate-group-invoice\", {\n group_ID: GROUP_ID,\n bill_From: \"2030-02-01T00:00:00\",\n bill_Thru: \"2030-02-28T00:00:00\",\n invoice_Date: \"2030-01-15T00:00:00\",\n due_Date: \"2030-02-01T00:00:00\",\n regenerate: false,\n })\n ).data;\n const invoiceKey: number = invoice.invoice_Key;\n console.log(\"Invoice\", invoiceKey, \"number\", invoice.invoice_Number, \"status\", invoice.invoice_Status);\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example response (illustrative; field values are fake, and some fields are left out):"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"data\": {\n \"invoice_Key\": 900001,\n \"invoice_Number\": \"DOCS-900001\",\n \"invoice_Level\": \"G\",\n \"invoice_Status\": \"OPEN\",\n \"billing_Cycle_ID\": \"MO\",\n \"billing_From\": \"2030-02-01T00:00:00\",\n \"billing_Thru\": \"2030-02-28T00:00:00\",\n \"invoice_Date\": \"2030-01-15T00:00:00\",\n \"due_Date\": \"2030-02-01T00:00:00\",\n \"bill_Name\": \"Sample Employer Group\",\n \"finalized\": false\n },\n \"error\": null,\n \"debug\": { \"activityID\": \"00000000-0000-0000-0000-000000000000\" }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save from the response:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.invoice_Key"]}," (the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoiceKey"]}," path parameter, and the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Invoice_Key"]}," column in the payment file)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Running it again:"]}," each call with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["regenerate"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," takes a new invoice key, so a second call creates a second invoice for the same period. To rebuild an existing invoice, use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/adv.-billing/regenerateinvoice"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /invoice-regenerate/{invoiceKey}"]}]},", which deletes the invoice and its attached adjustments and payments and rebuilds it under the same key. With ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["regenerate"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", this operation reuses the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoice_Key"]}," you send instead of taking a new one."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"3-review-the-invoice","__idx":6},"children":["3. Review the invoice"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/premium-invoices/getpreminvoicesummary"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /premium-invoices/{invoiceKey}/summary"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The summary totals the invoice: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["premium"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["premiumReceived"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postedPayment"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unpostedAmount"]},", the adjustment totals, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amountDue"]},", and subscriber and member counts. Check that the counts and premium match what you expect before you send the invoice or apply money to it. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/premium-invoices/getpreminvoice"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /premium-invoices/{invoiceKey}"]}]}," returns the invoice header. Both calls only read data."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/PremiumBillingPlaybook.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" var summary = (await api.GetAsync($\"/premium-invoices/{invoiceKey}/summary\")).Data!;\n Console.WriteLine($\"Premium: {summary[\"premium\"]} Amount due: {summary[\"amountDue\"]} Subscribers: {summary[\"subscriberCount\"]}\");\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premium_billing.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" summary = api.get(f\"/premium-invoices/{invoice_key}/summary\").data\n print(\"Premium:\", summary[\"premium\"], \"Amount due:\", summary[\"amountDue\"], \"Subscribers:\", summary[\"subscriberCount\"])\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premiumBilling.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" const summary = (await api.get(`/premium-invoices/${invoiceKey}/summary`)).data;\n console.log(\"Premium:\", summary.premium, \"Amount due:\", summary.amountDue, \"Subscribers:\", summary.subscriberCount);\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"4-find-the-payment-file-format","__idx":7},"children":["4. Find the payment file format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/premium-payment-file-formats/listprempaymentfileformat"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /premium-payment-file-formats"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The payment file request needs a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment_File_Format_Key"]},". List the formats and use the one your administrator set up for bank files. The samples print every format and use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DOCS_PAYMENT_FILE_FORMAT_KEY"]}," if it is set, otherwise the first one."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/PremiumBillingPlaybook.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" var formats = (await api.GetAsync(\"/premium-payment-file-formats\")).Data?.AsArray() ?? new JsonArray();\n foreach (var f in formats)\n Console.WriteLine($\"File format {f?[\"payment_File_Format_Key\"]} {f?[\"description\"]}\");\n var formatKey = int.TryParse(Environment.GetEnvironmentVariable(\"DOCS_PAYMENT_FILE_FORMAT_KEY\"), out var configured)\n ? configured\n : formats[0]![\"payment_File_Format_Key\"]!.GetValue();\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premium_billing.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" formats = api.get(\"/premium-payment-file-formats\").data or []\n for f in formats:\n print(\"File format\", f[\"payment_File_Format_Key\"], f[\"description\"])\n format_key = int(os.environ.get(\"DOCS_PAYMENT_FILE_FORMAT_KEY\") or formats[0][\"payment_File_Format_Key\"])\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premiumBilling.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" const formats: any[] = (await api.get(\"/premium-payment-file-formats\")).data ?? [];\n for (const f of formats) console.log(\"File format\", f.payment_File_Format_Key, f.description);\n const formatKey = Number(process.env.DOCS_PAYMENT_FILE_FORMAT_KEY ?? formats[0].payment_File_Format_Key);\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save from the response:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment_File_Format_Key"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"5-prepare-the-payment-file","__idx":8},"children":["5. Prepare the payment file"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The payment file is a CSV with a header row. These are the columns from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VBA_ProcessPaymentFile"]}," schema:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Column"},"children":["Column"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment_Account"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the paying account"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment_ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your unique ID for the payment, for example the bank reference"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment_Date"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment date, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YYYY-MM-DD"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment_Amount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Amount of the payment"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment_Name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the payer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payor_ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payor for the payment; the request's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payor_ID"]}," overrides it"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Account_Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account for the payment; the request's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account_Key"]}," overrides it when above ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment_Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A value from the premium payment types table"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment_Batch"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment_Batch_Seq"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Batch and sequence from your source system"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Group_ID"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Division_ID"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Subscriber_ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Who the payment is from"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Invoice_Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice to post the payment to"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PremRate_Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rate to apply the payment to"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PremPayment_Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Existing payment to apply the payment to"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This sample file has two fake payments: one for the invoice from step 2 and one with no invoice. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{INVOICE_KEY}}"]}," placeholder is replaced with the real invoice key before the file is sent; a file with the placeholder still in it is rejected."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/payments-sample.csv","language":"csv","header":{"controls":{"copy":{}}},"lang":"csv","source":"Payment_Type,Payment_Batch,Payment_Batch_Seq,Payment_Account,Payment_ID,Payment_Date,Payment_Amount,Payment_Name,Group_ID,Division_ID,Subscriber_ID,Payor_ID,Account_Key,Invoice_Key,PremRate_Key,PremPayment_Key\n,DOCS-BATCH-1,1,DOCS Sample Bank Account,DOCS-PAY-0001,2030-02-01,250.00,Sample Employer Group,DOCS-GRP1,,,DOCS-PAYOR,0,{{INVOICE_KEY}},,\n,DOCS-BATCH-1,2,DOCS Sample Bank Account,DOCS-PAY-0002,2030-02-01,75.00,Sample Employer Group,DOCS-GRP1,,,DOCS-PAYOR,0,,,\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The request sends the file as a base64-encoded string in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment_File"]},":"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/PremiumBillingPlaybook.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" var csvText = File.ReadAllText(SamplePath(\"payments-sample.csv\"))\n .Replace(\"{{INVOICE_KEY}}\", invoiceKey.ToString());\n var paymentFile = Convert.ToBase64String(Encoding.UTF8.GetBytes(csvText));\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premium_billing.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" csv_text = (SAMPLE_DIR / \"payments-sample.csv\").read_text(encoding=\"utf-8\")\n csv_text = csv_text.replace(\"{{INVOICE_KEY}}\", str(invoice_key))\n payment_file = base64.b64encode(csv_text.encode(\"utf-8\")).decode(\"ascii\")\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premiumBilling.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" const csvText = readFileSync(new URL(\"./payments-sample.csv\", import.meta.url), \"utf8\")\n .replace(\"{{INVOICE_KEY}}\", String(invoiceKey));\n const paymentFile = Buffer.from(csvText, \"utf8\").toString(\"base64\");\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"6-import-the-payment-file","__idx":9},"children":["6. Import the payment file"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/adv.-billing/processpaymentfile"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /process-payment-file"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This creates one premium payment for every row in the file and, depending on four options, posts the payments to invoices, applies them, and closes invoices. It returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," when it has finished. As with step 2, do not send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["user_ID"]},"; VBAPI sets it."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["What the four options do, from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BillingService.ProcessPaymentFile"]}," in the API source:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When true"},"children":["When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create_Invoice_Payments"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For each row with an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Invoice_Key"]},", posts the row's full ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment_Amount"]}," to that invoice. Rows without an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Invoice_Key"]}," only create a payment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apply_Payments"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Runs auto-apply on each invoice in the file, the same as ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/adv.-billing/preminvoiceautoapply"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /premium-invoices/{invoiceKey}/auto-apply"]}]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["close_Invoices"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recalculates the amount due on each invoice in the file. An invoice with nothing due is closed. An overpaid invoice goes through the invoice tolerance process and stays open. For an invoice that still has a balance, see the next row."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["only_Close_Satisfied_Invoices"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Leaves invoices that still have a balance open. When this is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["close_Invoices"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", VBAPI posts an adjustment for the remaining balance and closes the invoice anyway, so the unpaid amount is written off."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["A safe first run:"]}," create the payments and post them to invoices, but do not apply them or close anything. This is what the samples send:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"payment_File_Format_Key\": 1,\n \"payment_File\": \"UGF5bWVudF9UeXBlLFBheW1lbnRfQmF0Y2gs...\",\n \"payor_ID\": \"DOCS-PAYOR\",\n \"account_Key\": 0,\n \"create_Invoice_Payments\": true,\n \"apply_Payments\": false,\n \"close_Invoices\": false,\n \"only_Close_Satisfied_Invoices\": true\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After you have checked the result (step 7), apply the payments with auto-apply. Once you trust the file and the invoices, you can let the import apply and close in one run by setting ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apply_Payments"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["close_Invoices"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},". Keep ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["only_Close_Satisfied_Invoices"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," unless your finance team wants unpaid balances written off."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/PremiumBillingPlaybook.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" var result = (await api.PostAsync(\"/process-payment-file\", new\n {\n payment_File_Format_Key = formatKey,\n payment_File = paymentFile,\n payor_ID = PayorId,\n account_Key = AccountKey,\n create_Invoice_Payments = true,\n apply_Payments = false,\n close_Invoices = false,\n only_Close_Satisfied_Invoices = true,\n })).Data!;\n Console.WriteLine($\"Payments created: {result[\"payment_Created_Count\"]}\");\n Console.WriteLine($\"Invoice payments posted: {result[\"invoice_Payment_Posted_Count\"]}\");\n Console.WriteLine($\"Invoices closed: {result[\"invoice_Closed_Count\"]} left open: {result[\"invoice_Left_Open_Count\"]}\");\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premium_billing.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" result = api.post(\"/process-payment-file\", {\n \"payment_File_Format_Key\": format_key,\n \"payment_File\": payment_file,\n \"payor_ID\": PAYOR_ID,\n \"account_Key\": ACCOUNT_KEY,\n \"create_Invoice_Payments\": True,\n \"apply_Payments\": False,\n \"close_Invoices\": False,\n \"only_Close_Satisfied_Invoices\": True,\n }).data\n print(\"Payments created:\", result[\"payment_Created_Count\"])\n print(\"Invoice payments posted:\", result[\"invoice_Payment_Posted_Count\"])\n print(\"Invoices closed:\", result[\"invoice_Closed_Count\"], \"left open:\", result[\"invoice_Left_Open_Count\"])\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premiumBilling.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" const result = (\n await api.post(\"/process-payment-file\", {\n payment_File_Format_Key: formatKey,\n payment_File: paymentFile,\n payor_ID: PAYOR_ID,\n account_Key: ACCOUNT_KEY,\n create_Invoice_Payments: true,\n apply_Payments: false,\n close_Invoices: false,\n only_Close_Satisfied_Invoices: true,\n })\n ).data;\n console.log(\"Payments created:\", result.payment_Created_Count);\n console.log(\"Invoice payments posted:\", result.invoice_Payment_Posted_Count);\n console.log(\"Invoices closed:\", result.invoice_Closed_Count, \"left open:\", result.invoice_Left_Open_Count);\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example response for the sample file and the safe first run (illustrative):"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"data\": {\n \"payment_Created_Count\": 2,\n \"invoice_Payment_Posted_Count\": 1,\n \"invoice_Closed_Count\": 0,\n \"invoice_Left_Open_Count\": 1\n },\n \"error\": null,\n \"debug\": { \"activityID\": \"00000000-0000-0000-0000-000000000000\" }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to read the counts:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment_Created_Count"]},": rows in the file. Every row creates a payment, whatever the options."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoice_Payment_Posted_Count"]},": rows posted to an invoice. Zero when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create_Invoice_Payments"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoice_Closed_Count"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoice_Left_Open_Count"]},": the outcome for each row that has an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Invoice_Key"]},". With ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["close_Invoices"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},", every such row counts as left open."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Invoices left open:"]}," compare ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amountDue"]}," in the invoice summary (step 7). A short payment needs follow-up with the group, or an adjustment if your finance team approves one. An overpayment has been through the tolerance process; check the invoice in VBASoftware."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"7-apply-and-check-the-payments","__idx":10},"children":["7. Apply and check the payments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/adv.-billing/preminvoiceautoapply"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /premium-invoices/{invoiceKey}/auto-apply"]}]},", then ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/premium-invoice-payments/listpreminvoicepaymentext"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /premium-invoice-payments-ext/{invoiceKey}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Auto-apply spreads the payments posted to the invoice across its premium lines. It returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202"]}," and runs in the background, so wait a moment before you check. The samples only call it when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DOCS_APPLY_PAYMENTS"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The extended invoice payment list shows each payment posted to the invoice with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentPosted"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentApplied"]},", and the summary shows the new ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postedPayment"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amountDue"]},". Both calls only read data."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/PremiumBillingPlaybook.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" if (Environment.GetEnvironmentVariable(\"DOCS_APPLY_PAYMENTS\") == \"true\")\n {\n var accepted = await api.PostAsync($\"/premium-invoices/{invoiceKey}/auto-apply\");\n Console.WriteLine($\"Auto-apply accepted: {(int)accepted.Status}\"); // 202; it runs in the background\n }\n "},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/PremiumBillingPlaybook.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" await foreach (var p in api.GetAllAsync($\"/premium-invoice-payments-ext/{invoiceKey}\"))\n Console.WriteLine($\"Payment {p?[\"paymentId\"]} amount {p?[\"paymentAmount\"]} posted {p?[\"paymentPosted\"]} applied {p?[\"paymentApplied\"]}\");\n var after = (await api.GetAsync($\"/premium-invoices/{invoiceKey}/summary\")).Data!;\n Console.WriteLine($\"Posted payment: {after[\"postedPayment\"]} Amount due: {after[\"amountDue\"]}\");\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premium_billing.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" if os.environ.get(\"DOCS_APPLY_PAYMENTS\") == \"true\":\n accepted = api.post(f\"/premium-invoices/{invoice_key}/auto-apply\")\n print(\"Auto-apply accepted:\", accepted.status) # 202; it runs in the background\n "},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premium_billing.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" for p in api.iter_pages(f\"/premium-invoice-payments-ext/{invoice_key}\"):\n print(\"Payment\", p[\"paymentId\"], \"amount\", p[\"paymentAmount\"], \"posted\", p[\"paymentPosted\"], \"applied\", p[\"paymentApplied\"])\n summary = api.get(f\"/premium-invoices/{invoice_key}/summary\").data\n print(\"Posted payment:\", summary[\"postedPayment\"], \"Amount due:\", summary[\"amountDue\"])\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premiumBilling.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" if (process.env.DOCS_APPLY_PAYMENTS === \"true\") {\n const accepted = await api.post(`/premium-invoices/${invoiceKey}/auto-apply`);\n console.log(\"Auto-apply accepted:\", accepted.status); // 202; it runs in the background\n }\n "},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/premium-billing-and-payments/premiumBilling.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" for await (const p of api.getAll(`/premium-invoice-payments-ext/${invoiceKey}`)) {\n console.log(\"Payment\", p.paymentId, \"amount\", p.paymentAmount, \"posted\", p.paymentPosted, \"applied\", p.paymentApplied);\n }\n const after = (await api.get(`/premium-invoices/${invoiceKey}/summary`)).data;\n console.log(\"Posted payment:\", after.postedPayment, \"Amount due:\", after.amountDue);\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"verify-the-result","__idx":11},"children":["Verify the result"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These calls only read data:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/premium-invoices/getpreminvoicesummary"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /premium-invoices/{invoiceKey}/summary"]}]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postedPayment"]}," includes the posted amount, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amountDue"]}," has gone down once payments are applied."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/premium-invoice-payments/listpreminvoicepaymentext"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /premium-invoice-payments-ext/{invoiceKey}"]}]},": one entry per payment posted to the invoice, with its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["premPaymentKey"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentId"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/premium-payments/getprempayment"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /premium-payments/{premPaymentKey}"]}]},": the payment record, with the payor and account it was recorded against."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/premium-payments/listprempayment"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /premium-payments"]}]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/premium-invoice-payments/listpreminvoicepayment"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /premium-invoice-payments"]}]}," list every payment and invoice payment in the database. They have no filter parameters, so use the per-invoice list above where you can, and page through these when you need a payment that was not posted to an invoice."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"clean-up","__idx":12},"children":["Clean up"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Remove a payment from the invoices it was posted to with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/adv.-billing/undopremiumpayment"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /undo-premium-payment/{premPaymentKey}"]}]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202"]},"). It recalculates the received amounts on each affected invoice, and returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," if the payment was not posted to any invoice."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Delete a test payment with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/premium-payments/deleteprempayment"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /premium-payments/{premPaymentKey}"]}]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204"]},"). Undo it first if it was posted to an invoice."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Delete a test invoice with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/adv.-billing/fulldeleteinvoice"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /invoice-full-delete/{invoiceKey}"]}]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202"]},"). It requires the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleteAdditionalInvoices"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keepManualAdjustments"]}," query parameters."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-errors","__idx":13},"children":["Common errors"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Symptom"},"children":["Symptom"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Likely cause"},"children":["Likely cause"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Fix"},"children":["Fix"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," \"You must pass in a valid Group ID\" or \"valid Bill From\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["group_ID"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bill_From"]}," is missing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Send both"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," \"the Division ID must be blank\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["division_ID"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscriber_ID"]}," was sent to the group invoice operation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Leave them out, or use the division variation below"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}," \"PremInvoice not found\" from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /generate-group-invoice"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Nothing was billable for the period, so no invoice was created. A division copied with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["copyPremiums"]}," does not bring the template's group-level premium rates"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check the group's rates with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /included-premium-rates?groupId=..."]}," and the enrollment dates"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An error from the invoice summary"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The invoice has no subscriber or self-admin lines, for example because nobody was enrolled for the period"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check the billing period and the group's enrollment"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," \"Invalid payment file\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment_File"]}," is empty, is not base64, or has no data rows"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Base64-encode the whole CSV, header row included"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An error when the file is processed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A column has the wrong type, for example the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{INVOICE_KEY}}"]}," placeholder was not replaced"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fix the row; numbers and dates must parse"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payments created twice"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The same file was imported twice"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Each import creates a payment per row; undo and delete the duplicates"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"message\":\"Forbidden\"}"]}," on every call"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-api-key"]}," header is missing or wrong"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/concepts/errors"},"children":["errors"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Contacting support"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send VBA support:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["debug.activityID"]}," from the response"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the date and time of the call, with time zone"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the method and path, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /claim-batches"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the full ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}," object from the response"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the request body, with passwords, tokens, and personal data removed"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Never send your password, API key, or tokens. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/help/support"},"children":["Support and escalation"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"variations","__idx":14},"children":["Variations"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Group and division invoices together:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/adv.-billing/generatepreminvoicegroupdivision"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /generate-group-division-invoice"]}]}," takes the same body. It creates the group invoice for divisions billed at group level and a separate invoice for each division billed at division level. It returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202"]}," with no body, so find the new invoices afterwards with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/premium-invoices/listpreminvoiceslim"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /premium-invoices-slim"]}]}," and its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoiceYear"]}," filters."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Safe to re-run?"]}," No. Generating again creates another invoice, and importing the same file again creates the payments again. Keep track of the invoice keys and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment_ID"]}," values you have already sent."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"download","__idx":15},"children":["Download"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The complete runnable samples are in the documentation repository under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_samples/playbooks/premium-billing-and-payments/"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PremiumBillingPlaybook.cs"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["premium_billing.py"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["premiumBilling.ts"]},", and the sample payment file ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payments-sample.csv"]},", which each sample reads from its own folder. Each sample uses the shared helper for its language described in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/get-started/quick-start"},"children":["quick start"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":16},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Concepts: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/concepts/data-model"},"children":["data model"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/concepts/requests-and-responses"},"children":["requests and responses"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/concepts/pagination-and-sorting"},"children":["pagination"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Previous playbook: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/playbooks/claims-intake-and-adjudication"},"children":["Enter claims and adjudicate them"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ask the AI: \"Using the Bill premiums and apply payments playbook, write a C# function that turns our bank's lockbox file into the VBAPI payment file and imports it without closing invoices.\""]}]}]},"headings":[{"value":"Bill premiums and apply payments","id":"bill-premiums-and-apply-payments","depth":1},{"value":"Before you start","id":"before-you-start","depth":2},{"value":"How it fits together","id":"how-it-fits-together","depth":2},{"value":"Steps","id":"steps","depth":2},{"value":"1. Confirm the group's billing cycle","id":"1-confirm-the-groups-billing-cycle","depth":3},{"value":"2. Generate the group invoice","id":"2-generate-the-group-invoice","depth":3},{"value":"3. Review the invoice","id":"3-review-the-invoice","depth":3},{"value":"4. Find the payment file format","id":"4-find-the-payment-file-format","depth":3},{"value":"5. Prepare the payment file","id":"5-prepare-the-payment-file","depth":3},{"value":"6. Import the payment file","id":"6-import-the-payment-file","depth":3},{"value":"7. Apply and check the payments","id":"7-apply-and-check-the-payments","depth":3},{"value":"Verify the result","id":"verify-the-result","depth":2},{"value":"Clean up","id":"clean-up","depth":2},{"value":"Common errors","id":"common-errors","depth":2},{"value":"Variations","id":"variations","depth":2},{"value":"Download","id":"download","depth":2},{"value":"Related","id":"related","depth":2}],"frontmatter":{"title":"Bill premiums and apply payments","description":"Generate a group premium invoice with VBAPI, review it, and import a bank payment file that creates payments and posts them to invoices.","seo":{"title":"Bill premiums and apply payments"}},"lastModified":"2026-10-26T21:09:33.694Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal/playbooks/premium-billing-and-payments","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}