Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Invoice Management Invoice Configurations API
version: 1.0.0
description: Provides endpoints for configuring and managing invoice run requests.
servers:
- url: https://rls.congacloud.com/api/invoicing/v1
security:
- Bearer: []
tags:
- name: Invoice Configurations
description: Provides endpoints for configuring and managing invoice run requests.
paths:
/configure-requests:
patch:
tags:
- Invoice Configurations
summary: Updates an existing invoice configuration request with modified settings.
requestBody:
description: The invoice configuration request containing updated settings for the invoice run.
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationRequest'
example: "{\n \"Id\": \"example-invoice-configuration-id\",\n \"Name\": \"Monthly Invoice Run - January 2026\",\n \"RunType\": \"Immediate\",\n \"AutoApproveInvoices\": true,\n \"Status\": \"Draft\",\n \"InvoiceDateType\": \"Ready for Invoice Date\",\n \"ProcessFrom\": \"2025-06-15T00:00:00\",\n \"ProcessTo\": \"2026-08-20T00:00:00\",\n \"FilterCriteria\": {\n \"ParentOperator\": \"AND\",\n \"Rules\": [\n {\n \"ObjectName\": \"Account\",\n \"ChildOperator\": \"OR\",\n \"Rules\": [\n {\n \"FieldName\": \"Name\",\n \"ComparisonOperator\": \"LIKE\",\n \"FieldType\": \"STRING\",\n \"FieldValue\": \"Acme%\"\n },\n {\n \"FieldName\": \"AccountNumber\",\n \"ComparisonOperator\": \"IN\",\n \"FieldType\": \"STRING\",\n \"FieldValue\": [\n \"ACC-001\",\n \"ACC-002\",\n \"ACC-003\"\n ]\n }\n ]\n },\n {\n \"ObjectName\": \"Product\",\n \"ChildOperator\": \"AND\",\n \"Rules\": [\n {\n \"FieldName\": \"IsActive\",\n \"ComparisonOperator\": \"=\",\n \"FieldType\": \"BOOLEAN\",\n \"FieldValue\": true\n },\n {\n \"FieldName\": \"ProductFamily\",\n \"ComparisonOperator\": \"=\",\n \"FieldType\": \"PICKLIST\",\n \"FieldValue\": \"Subscription\"\n }\n ]\n },\n {\n \"ObjectName\": \"BillingScheduleRecord\",\n \"ChildOperator\": \"AND\",\n \"Rules\": [\n {\n \"FieldName\": \"ReadyForInvoiceDate\",\n \"ComparisonOperator\": \"\\u003E=\",\n \"FieldType\": \"DATE\",\n \"FieldValue\": \"2025-01-01\"\n },\n {\n \"FieldName\": \"NetPrice\",\n \"ComparisonOperator\": \"\\u003E\",\n \"FieldType\": \"CURRENCY\",\n \"FieldValue\": 100\n }\n ]\n }\n ]\n },\n \"FilterCriteriaOld\": null,\n \"CreateCreditMemos\": true,\n \"CreditMemoCreationOption\": \"One Per Negative Billing Schedule\",\n \"InvoiceDate\": null,\n \"CreditMemoDateBasedOn\": \"Ready for Invoice Date\",\n \"CreditMemoDate\": null,\n \"AutoApproveAmountOperator\": \"Less than or equal to\",\n \"AutoApproveAmount\": {\n \"Value\": 10000,\n \"DisplayValue\": 0,\n \"CurrencyCode\": null,\n \"CurrencySymbol\": null\n },\n \"SuppressCriterion\": \"Amount\",\n \"SuppressOperator\": \"Less than\",\n \"SuppressInvoiceAmount\": {\n \"Value\": 10,\n \"DisplayValue\": 0,\n \"CurrencyCode\": null,\n \"CurrencySymbol\": null\n },\n \"AutoApplyCreditMemo\": true,\n \"AutoApproveCreditMemos\": true,\n \"Frequency\": \"Monthly by Date\",\n \"WeekOfTheMonth\": \"The 1st\",\n \"WeekDay\": [\n \"Monday\"\n ],\n \"InvoiceDayReference\": \"Last\",\n \"InvoiceMonthReference\": \"Current Month\",\n \"InvoiceDateOffset\": \"0\",\n \"ProcessThroughOffset\": \"0\",\n \"StartHour\": \"00\",\n \"StartMinute\": \"00\",\n \"OverwriteInvoiceTemplates\": true,\n \"InvoiceDocumentTemplate\": {\n \"Id\": \"TMPL-INV-001\",\n \"Name\": \"Standard Invoice Template\"\n },\n \"InvoiceEmailTemplate\": {\n \"Id\": \"TMPL-EMAIL-INV-001\",\n \"Name\": \"Invoice Email Template\"\n },\n \"OverwriteCreditMemoTemplates\": true,\n \"CreditMemoDocumentTemplate\": {\n \"Id\": \"TMPL-CM-001\",\n \"Name\": \"Standard Credit Memo Template\"\n },\n \"CreditMemoEmailTemplate\": {\n \"Id\": \"TMPL-EMAIL-CM-001\",\n \"Name\": \"Credit Memo Email Template\"\n },\n \"SplitCriteria\": null,\n \"MonthlyDate\": null,\n \"ProcessFromDayReference\": null,\n \"ProcessFromMonthReference\": null,\n \"ProcessToDayReference\": null,\n \"ProcessToMonthReference\": null,\n \"ProcessFromOffset\": null,\n \"ScheduleFrom\": null,\n \"ScheduleTo\": null\n}"
text/json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationRequest'
example: "{\n \"Id\": \"example-invoice-configuration-id\",\n \"Name\": \"Monthly Invoice Run - January 2026\",\n \"RunType\": \"Immediate\",\n \"AutoApproveInvoices\": true,\n \"Status\": \"Draft\",\n \"InvoiceDateType\": \"Ready for Invoice Date\",\n \"ProcessFrom\": \"2025-06-15T00:00:00\",\n \"ProcessTo\": \"2026-08-20T00:00:00\",\n \"FilterCriteria\": {\n \"ParentOperator\": \"AND\",\n \"Rules\": [\n {\n \"ObjectName\": \"Account\",\n \"ChildOperator\": \"OR\",\n \"Rules\": [\n {\n \"FieldName\": \"Name\",\n \"ComparisonOperator\": \"LIKE\",\n \"FieldType\": \"STRING\",\n \"FieldValue\": \"Acme%\"\n },\n {\n \"FieldName\": \"AccountNumber\",\n \"ComparisonOperator\": \"IN\",\n \"FieldType\": \"STRING\",\n \"FieldValue\": [\n \"ACC-001\",\n \"ACC-002\",\n \"ACC-003\"\n ]\n }\n ]\n },\n {\n \"ObjectName\": \"Product\",\n \"ChildOperator\": \"AND\",\n \"Rules\": [\n {\n \"FieldName\": \"IsActive\",\n \"ComparisonOperator\": \"=\",\n \"FieldType\": \"BOOLEAN\",\n \"FieldValue\": true\n },\n {\n \"FieldName\": \"ProductFamily\",\n \"ComparisonOperator\": \"=\",\n \"FieldType\": \"PICKLIST\",\n \"FieldValue\": \"Subscription\"\n }\n ]\n },\n {\n \"ObjectName\": \"BillingScheduleRecord\",\n \"ChildOperator\": \"AND\",\n \"Rules\": [\n {\n \"FieldName\": \"ReadyForInvoiceDate\",\n \"ComparisonOperator\": \"\\u003E=\",\n \"FieldType\": \"DATE\",\n \"FieldValue\": \"2025-01-01\"\n },\n {\n \"FieldName\": \"NetPrice\",\n \"ComparisonOperator\": \"\\u003E\",\n \"FieldType\": \"CURRENCY\",\n \"FieldValue\": 100\n }\n ]\n }\n ]\n },\n \"FilterCriteriaOld\": null,\n \"CreateCreditMemos\": true,\n \"CreditMemoCreationOption\": \"One Per Negative Billing Schedule\",\n \"InvoiceDate\": null,\n \"CreditMemoDateBasedOn\": \"Ready for Invoice Date\",\n \"CreditMemoDate\": null,\n \"AutoApproveAmountOperator\": \"Less than or equal to\",\n \"AutoApproveAmount\": {\n \"Value\": 10000,\n \"DisplayValue\": 0,\n \"CurrencyCode\": null,\n \"CurrencySymbol\": null\n },\n \"SuppressCriterion\": \"Amount\",\n \"SuppressOperator\": \"Less than\",\n \"SuppressInvoiceAmount\": {\n \"Value\": 10,\n \"DisplayValue\": 0,\n \"CurrencyCode\": null,\n \"CurrencySymbol\": null\n },\n \"AutoApplyCreditMemo\": true,\n \"AutoApproveCreditMemos\": true,\n \"Frequency\": \"Monthly by Date\",\n \"WeekOfTheMonth\": \"The 1st\",\n \"WeekDay\": [\n \"Monday\"\n ],\n \"InvoiceDayReference\": \"Last\",\n \"InvoiceMonthReference\": \"Current Month\",\n \"InvoiceDateOffset\": \"0\",\n \"ProcessThroughOffset\": \"0\",\n \"StartHour\": \"00\",\n \"StartMinute\": \"00\",\n \"OverwriteInvoiceTemplates\": true,\n \"InvoiceDocumentTemplate\": {\n \"Id\": \"TMPL-INV-001\",\n \"Name\": \"Standard Invoice Template\"\n },\n \"InvoiceEmailTemplate\": {\n \"Id\": \"TMPL-EMAIL-INV-001\",\n \"Name\": \"Invoice Email Template\"\n },\n \"OverwriteCreditMemoTemplates\": true,\n \"CreditMemoDocumentTemplate\": {\n \"Id\": \"TMPL-CM-001\",\n \"Name\": \"Standard Credit Memo Template\"\n },\n \"CreditMemoEmailTemplate\": {\n \"Id\": \"TMPL-EMAIL-CM-001\",\n \"Name\": \"Credit Memo Email Template\"\n },\n \"SplitCriteria\": null,\n \"MonthlyDate\": null,\n \"ProcessFromDayReference\": null,\n \"ProcessFromMonthReference\": null,\n \"ProcessToDayReference\": null,\n \"ProcessToMonthReference\": null,\n \"ProcessFromOffset\": null,\n \"ScheduleFrom\": null,\n \"ScheduleTo\": null\n}"
application/*+json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationRequest'
example: "{\n \"Id\": \"example-invoice-configuration-id\",\n \"Name\": \"Monthly Invoice Run - January 2026\",\n \"RunType\": \"Immediate\",\n \"AutoApproveInvoices\": true,\n \"Status\": \"Draft\",\n \"InvoiceDateType\": \"Ready for Invoice Date\",\n \"ProcessFrom\": \"2025-06-15T00:00:00\",\n \"ProcessTo\": \"2026-08-20T00:00:00\",\n \"FilterCriteria\": {\n \"ParentOperator\": \"AND\",\n \"Rules\": [\n {\n \"ObjectName\": \"Account\",\n \"ChildOperator\": \"OR\",\n \"Rules\": [\n {\n \"FieldName\": \"Name\",\n \"ComparisonOperator\": \"LIKE\",\n \"FieldType\": \"STRING\",\n \"FieldValue\": \"Acme%\"\n },\n {\n \"FieldName\": \"AccountNumber\",\n \"ComparisonOperator\": \"IN\",\n \"FieldType\": \"STRING\",\n \"FieldValue\": [\n \"ACC-001\",\n \"ACC-002\",\n \"ACC-003\"\n ]\n }\n ]\n },\n {\n \"ObjectName\": \"Product\",\n \"ChildOperator\": \"AND\",\n \"Rules\": [\n {\n \"FieldName\": \"IsActive\",\n \"ComparisonOperator\": \"=\",\n \"FieldType\": \"BOOLEAN\",\n \"FieldValue\": true\n },\n {\n \"FieldName\": \"ProductFamily\",\n \"ComparisonOperator\": \"=\",\n \"FieldType\": \"PICKLIST\",\n \"FieldValue\": \"Subscription\"\n }\n ]\n },\n {\n \"ObjectName\": \"BillingScheduleRecord\",\n \"ChildOperator\": \"AND\",\n \"Rules\": [\n {\n \"FieldName\": \"ReadyForInvoiceDate\",\n \"ComparisonOperator\": \"\\u003E=\",\n \"FieldType\": \"DATE\",\n \"FieldValue\": \"2025-01-01\"\n },\n {\n \"FieldName\": \"NetPrice\",\n \"ComparisonOperator\": \"\\u003E\",\n \"FieldType\": \"CURRENCY\",\n \"FieldValue\": 100\n }\n ]\n }\n ]\n },\n \"FilterCriteriaOld\": null,\n \"CreateCreditMemos\": true,\n \"CreditMemoCreationOption\": \"One Per Negative Billing Schedule\",\n \"InvoiceDate\": null,\n \"CreditMemoDateBasedOn\": \"Ready for Invoice Date\",\n \"CreditMemoDate\": null,\n \"AutoApproveAmountOperator\": \"Less than or equal to\",\n \"AutoApproveAmount\": {\n \"Value\": 10000,\n \"DisplayValue\": 0,\n \"CurrencyCode\": null,\n \"CurrencySymbol\": null\n },\n \"SuppressCriterion\": \"Amount\",\n \"SuppressOperator\": \"Less than\",\n \"SuppressInvoiceAmount\": {\n \"Value\": 10,\n \"DisplayValue\": 0,\n \"CurrencyCode\": null,\n \"CurrencySymbol\": null\n },\n \"AutoApplyCreditMemo\": true,\n \"AutoApproveCreditMemos\": true,\n \"Frequency\": \"Monthly by Date\",\n \"WeekOfTheMonth\": \"The 1st\",\n \"WeekDay\": [\n \"Monday\"\n ],\n \"InvoiceDayReference\": \"Last\",\n \"InvoiceMonthReference\": \"Current Month\",\n \"InvoiceDateOffset\": \"0\",\n \"ProcessThroughOffset\": \"0\",\n \"StartHour\": \"00\",\n \"StartMinute\": \"00\",\n \"OverwriteInvoiceTemplates\": true,\n \"InvoiceDocumentTemplate\": {\n \"Id\": \"TMPL-INV-001\",\n \"Name\": \"Standard Invoice Template\"\n },\n \"InvoiceEmailTemplate\": {\n \"Id\": \"TMPL-EMAIL-INV-001\",\n \"Name\": \"Invoice Email Template\"\n },\n \"OverwriteCreditMemoTemplates\": true,\n \"CreditMemoDocumentTemplate\": {\n \"Id\": \"TMPL-CM-001\",\n \"Name\": \"Standard Credit Memo Template\"\n },\n \"CreditMemoEmailTemplate\": {\n \"Id\": \"TMPL-EMAIL-CM-001\",\n \"Name\": \"Credit Memo Email Template\"\n },\n \"SplitCriteria\": null,\n \"MonthlyDate\": null,\n \"ProcessFromDayReference\": null,\n \"ProcessFromMonthReference\": null,\n \"ProcessToDayReference\": null,\n \"ProcessToMonthReference\": null,\n \"ProcessFromOffset\": null,\n \"ScheduleFrom\": null,\n \"ScheduleTo\": null\n}"
responses:
'200':
description: OK
content:
text/plain:
schema:
$ref: '#/components/schemas/InvoiceConfigurationResponseBatchResponse'
application/json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationResponseBatchResponse'
text/json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationResponseBatchResponse'
'400':
description: Bad Request
content:
text/plain:
schema:
$ref: '#/components/schemas/InvoiceConfigurationResponseBatchResponse'
application/json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationResponseBatchResponse'
text/json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationResponseBatchResponse'
'500':
description: Internal Server Error
content:
text/plain:
schema:
$ref: '#/components/schemas/ErrorApiResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorApiResponse'
text/json:
schema:
$ref: '#/components/schemas/ErrorApiResponse'
post:
tags:
- Invoice Configurations
summary: Configures and creates an invoice run request based on the provided configuration.
requestBody:
description: The invoice configuration request containing settings for the invoice run.
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationRequest'
example: "{\n \"Name\": \"Monthly Invoice Run - January 2026\",\n \"RunType\": \"Immediate\",\n \"AutoApproveInvoices\": true,\n \"Status\": \"Draft\",\n \"InvoiceDateType\": \"Ready for Invoice Date\",\n \"ProcessFrom\": \"2025-06-15T00:00:00\",\n \"ProcessTo\": \"2026-08-20T00:00:00\",\n \"FilterCriteria\": {\n \"ParentOperator\": \"AND\",\n \"Rules\": [\n {\n \"ObjectName\": \"Account\",\n \"ChildOperator\": \"OR\",\n \"Rules\": [\n {\n \"FieldName\": \"Name\",\n \"ComparisonOperator\": \"LIKE\",\n \"FieldType\": \"STRING\",\n \"FieldValue\": \"Acme%\"\n },\n {\n \"FieldName\": \"AccountNumber\",\n \"ComparisonOperator\": \"IN\",\n \"FieldType\": \"STRING\",\n \"FieldValue\": [\n \"ACC-001\",\n \"ACC-002\",\n \"ACC-003\"\n ]\n }\n ]\n },\n {\n \"ObjectName\": \"Product\",\n \"ChildOperator\": \"AND\",\n \"Rules\": [\n {\n \"FieldName\": \"IsActive\",\n \"ComparisonOperator\": \"=\",\n \"FieldType\": \"BOOLEAN\",\n \"FieldValue\": true\n },\n {\n \"FieldName\": \"ProductFamily\",\n \"ComparisonOperator\": \"=\",\n \"FieldType\": \"PICKLIST\",\n \"FieldValue\": \"Subscription\"\n }\n ]\n },\n {\n \"ObjectName\": \"BillingScheduleRecord\",\n \"ChildOperator\": \"AND\",\n \"Rules\": [\n {\n \"FieldName\": \"ReadyForInvoiceDate\",\n \"ComparisonOperator\": \"\\u003E=\",\n \"FieldType\": \"DATE\",\n \"FieldValue\": \"2025-01-01\"\n },\n {\n \"FieldName\": \"NetPrice\",\n \"ComparisonOperator\": \"\\u003E\",\n \"FieldType\": \"CURRENCY\",\n \"FieldValue\": 100\n }\n ]\n }\n ]\n },\n \"FilterCriteriaOld\": null,\n \"CreateCreditMemos\": true,\n \"CreditMemoCreationOption\": \"One Per Negative Billing Schedule\",\n \"InvoiceDate\": null,\n \"CreditMemoDateBasedOn\": \"Ready for Invoice Date\",\n \"CreditMemoDate\": null,\n \"AutoApproveAmountOperator\": \"Less than or equal to\",\n \"AutoApproveAmount\": {\n \"Value\": 10000,\n \"DisplayValue\": 0,\n \"CurrencyCode\": null,\n \"CurrencySymbol\": null\n },\n \"SuppressCriterion\": \"Amount\",\n \"SuppressOperator\": \"Less than\",\n \"SuppressInvoiceAmount\": {\n \"Value\": 10,\n \"DisplayValue\": 0,\n \"CurrencyCode\": null,\n \"CurrencySymbol\": null\n },\n \"AutoApplyCreditMemo\": true,\n \"AutoApproveCreditMemos\": true,\n \"Frequency\": \"Monthly by Date\",\n \"WeekOfTheMonth\": \"The 1st\",\n \"WeekDay\": [\n \"Monday\"\n ],\n \"InvoiceDayReference\": \"Last\",\n \"InvoiceMonthReference\": \"Current Month\",\n \"InvoiceDateOffset\": \"0\",\n \"ProcessThroughOffset\": \"0\",\n \"StartHour\": \"00\",\n \"StartMinute\": \"00\",\n \"OverwriteInvoiceTemplates\": true,\n \"InvoiceDocumentTemplate\": {\n \"Name\": \"Standard Invoice Template\"\n },\n \"InvoiceEmailTemplate\": {\n \"Name\": \"Invoice Email Template\"\n },\n \"OverwriteCreditMemoTemplates\": true,\n \"CreditMemoDocumentTemplate\": {\n \"Name\": \"Standard Credit Memo Template\"\n },\n \"CreditMemoEmailTemplate\": {\n \"Name\": \"Credit Memo Email Template\"\n },\n \"SplitCriteria\": null,\n \"MonthlyDate\": null,\n \"ProcessFromDayReference\": null,\n \"ProcessFromMonthReference\": null,\n \"ProcessToDayReference\": null,\n \"ProcessToMonthReference\": null,\n \"ProcessFromOffset\": null,\n \"ScheduleFrom\": null,\n \"ScheduleTo\": null\n}"
text/json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationRequest'
example: "{\n \"Name\": \"Monthly Invoice Run - January 2026\",\n \"RunType\": \"Immediate\",\n \"AutoApproveInvoices\": true,\n \"Status\": \"Draft\",\n \"InvoiceDateType\": \"Ready for Invoice Date\",\n \"ProcessFrom\": \"2025-06-15T00:00:00\",\n \"ProcessTo\": \"2026-08-20T00:00:00\",\n \"FilterCriteria\": {\n \"ParentOperator\": \"AND\",\n \"Rules\": [\n {\n \"ObjectName\": \"Account\",\n \"ChildOperator\": \"OR\",\n \"Rules\": [\n {\n \"FieldName\": \"Name\",\n \"ComparisonOperator\": \"LIKE\",\n \"FieldType\": \"STRING\",\n \"FieldValue\": \"Acme%\"\n },\n {\n \"FieldName\": \"AccountNumber\",\n \"ComparisonOperator\": \"IN\",\n \"FieldType\": \"STRING\",\n \"FieldValue\": [\n \"ACC-001\",\n \"ACC-002\",\n \"ACC-003\"\n ]\n }\n ]\n },\n {\n \"ObjectName\": \"Product\",\n \"ChildOperator\": \"AND\",\n \"Rules\": [\n {\n \"FieldName\": \"IsActive\",\n \"ComparisonOperator\": \"=\",\n \"FieldType\": \"BOOLEAN\",\n \"FieldValue\": true\n },\n {\n \"FieldName\": \"ProductFamily\",\n \"ComparisonOperator\": \"=\",\n \"FieldType\": \"PICKLIST\",\n \"FieldValue\": \"Subscription\"\n }\n ]\n },\n {\n \"ObjectName\": \"BillingScheduleRecord\",\n \"ChildOperator\": \"AND\",\n \"Rules\": [\n {\n \"FieldName\": \"ReadyForInvoiceDate\",\n \"ComparisonOperator\": \"\\u003E=\",\n \"FieldType\": \"DATE\",\n \"FieldValue\": \"2025-01-01\"\n },\n {\n \"FieldName\": \"NetPrice\",\n \"ComparisonOperator\": \"\\u003E\",\n \"FieldType\": \"CURRENCY\",\n \"FieldValue\": 100\n }\n ]\n }\n ]\n },\n \"FilterCriteriaOld\": null,\n \"CreateCreditMemos\": true,\n \"CreditMemoCreationOption\": \"One Per Negative Billing Schedule\",\n \"InvoiceDate\": null,\n \"CreditMemoDateBasedOn\": \"Ready for Invoice Date\",\n \"CreditMemoDate\": null,\n \"AutoApproveAmountOperator\": \"Less than or equal to\",\n \"AutoApproveAmount\": {\n \"Value\": 10000,\n \"DisplayValue\": 0,\n \"CurrencyCode\": null,\n \"CurrencySymbol\": null\n },\n \"SuppressCriterion\": \"Amount\",\n \"SuppressOperator\": \"Less than\",\n \"SuppressInvoiceAmount\": {\n \"Value\": 10,\n \"DisplayValue\": 0,\n \"CurrencyCode\": null,\n \"CurrencySymbol\": null\n },\n \"AutoApplyCreditMemo\": true,\n \"AutoApproveCreditMemos\": true,\n \"Frequency\": \"Monthly by Date\",\n \"WeekOfTheMonth\": \"The 1st\",\n \"WeekDay\": [\n \"Monday\"\n ],\n \"InvoiceDayReference\": \"Last\",\n \"InvoiceMonthReference\": \"Current Month\",\n \"InvoiceDateOffset\": \"0\",\n \"ProcessThroughOffset\": \"0\",\n \"StartHour\": \"00\",\n \"StartMinute\": \"00\",\n \"OverwriteInvoiceTemplates\": true,\n \"InvoiceDocumentTemplate\": {\n \"Name\": \"Standard Invoice Template\"\n },\n \"InvoiceEmailTemplate\": {\n \"Name\": \"Invoice Email Template\"\n },\n \"OverwriteCreditMemoTemplates\": true,\n \"CreditMemoDocumentTemplate\": {\n \"Name\": \"Standard Credit Memo Template\"\n },\n \"CreditMemoEmailTemplate\": {\n \"Name\": \"Credit Memo Email Template\"\n },\n \"SplitCriteria\": null,\n \"MonthlyDate\": null,\n \"ProcessFromDayReference\": null,\n \"ProcessFromMonthReference\": null,\n \"ProcessToDayReference\": null,\n \"ProcessToMonthReference\": null,\n \"ProcessFromOffset\": null,\n \"ScheduleFrom\": null,\n \"ScheduleTo\": null\n}"
application/*+json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationRequest'
example: "{\n \"Name\": \"Monthly Invoice Run - January 2026\",\n \"RunType\": \"Immediate\",\n \"AutoApproveInvoices\": true,\n \"Status\": \"Draft\",\n \"InvoiceDateType\": \"Ready for Invoice Date\",\n \"ProcessFrom\": \"2025-06-15T00:00:00\",\n \"ProcessTo\": \"2026-08-20T00:00:00\",\n \"FilterCriteria\": {\n \"ParentOperator\": \"AND\",\n \"Rules\": [\n {\n \"ObjectName\": \"Account\",\n \"ChildOperator\": \"OR\",\n \"Rules\": [\n {\n \"FieldName\": \"Name\",\n \"ComparisonOperator\": \"LIKE\",\n \"FieldType\": \"STRING\",\n \"FieldValue\": \"Acme%\"\n },\n {\n \"FieldName\": \"AccountNumber\",\n \"ComparisonOperator\": \"IN\",\n \"FieldType\": \"STRING\",\n \"FieldValue\": [\n \"ACC-001\",\n \"ACC-002\",\n \"ACC-003\"\n ]\n }\n ]\n },\n {\n \"ObjectName\": \"Product\",\n \"ChildOperator\": \"AND\",\n \"Rules\": [\n {\n \"FieldName\": \"IsActive\",\n \"ComparisonOperator\": \"=\",\n \"FieldType\": \"BOOLEAN\",\n \"FieldValue\": true\n },\n {\n \"FieldName\": \"ProductFamily\",\n \"ComparisonOperator\": \"=\",\n \"FieldType\": \"PICKLIST\",\n \"FieldValue\": \"Subscription\"\n }\n ]\n },\n {\n \"ObjectName\": \"BillingScheduleRecord\",\n \"ChildOperator\": \"AND\",\n \"Rules\": [\n {\n \"FieldName\": \"ReadyForInvoiceDate\",\n \"ComparisonOperator\": \"\\u003E=\",\n \"FieldType\": \"DATE\",\n \"FieldValue\": \"2025-01-01\"\n },\n {\n \"FieldName\": \"NetPrice\",\n \"ComparisonOperator\": \"\\u003E\",\n \"FieldType\": \"CURRENCY\",\n \"FieldValue\": 100\n }\n ]\n }\n ]\n },\n \"FilterCriteriaOld\": null,\n \"CreateCreditMemos\": true,\n \"CreditMemoCreationOption\": \"One Per Negative Billing Schedule\",\n \"InvoiceDate\": null,\n \"CreditMemoDateBasedOn\": \"Ready for Invoice Date\",\n \"CreditMemoDate\": null,\n \"AutoApproveAmountOperator\": \"Less than or equal to\",\n \"AutoApproveAmount\": {\n \"Value\": 10000,\n \"DisplayValue\": 0,\n \"CurrencyCode\": null,\n \"CurrencySymbol\": null\n },\n \"SuppressCriterion\": \"Amount\",\n \"SuppressOperator\": \"Less than\",\n \"SuppressInvoiceAmount\": {\n \"Value\": 10,\n \"DisplayValue\": 0,\n \"CurrencyCode\": null,\n \"CurrencySymbol\": null\n },\n \"AutoApplyCreditMemo\": true,\n \"AutoApproveCreditMemos\": true,\n \"Frequency\": \"Monthly by Date\",\n \"WeekOfTheMonth\": \"The 1st\",\n \"WeekDay\": [\n \"Monday\"\n ],\n \"InvoiceDayReference\": \"Last\",\n \"InvoiceMonthReference\": \"Current Month\",\n \"InvoiceDateOffset\": \"0\",\n \"ProcessThroughOffset\": \"0\",\n \"StartHour\": \"00\",\n \"StartMinute\": \"00\",\n \"OverwriteInvoiceTemplates\": true,\n \"InvoiceDocumentTemplate\": {\n \"Name\": \"Standard Invoice Template\"\n },\n \"InvoiceEmailTemplate\": {\n \"Name\": \"Invoice Email Template\"\n },\n \"OverwriteCreditMemoTemplates\": true,\n \"CreditMemoDocumentTemplate\": {\n \"Name\": \"Standard Credit Memo Template\"\n },\n \"CreditMemoEmailTemplate\": {\n \"Name\": \"Credit Memo Email Template\"\n },\n \"SplitCriteria\": null,\n \"MonthlyDate\": null,\n \"ProcessFromDayReference\": null,\n \"ProcessFromMonthReference\": null,\n \"ProcessToDayReference\": null,\n \"ProcessToMonthReference\": null,\n \"ProcessFromOffset\": null,\n \"ScheduleFrom\": null,\n \"ScheduleTo\": null\n}"
responses:
'201':
description: Created
content:
text/plain:
schema:
$ref: '#/components/schemas/InvoiceConfigurationResponse'
application/json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationResponse'
text/json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationResponse'
'400':
description: Bad Request
content:
text/plain:
schema:
$ref: '#/components/schemas/InvoiceConfigurationResponse'
application/json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationResponse'
text/json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationResponse'
'500':
description: Internal Server Error
content:
text/plain:
schema:
$ref: '#/components/schemas/ErrorApiResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorApiResponse'
text/json:
schema:
$ref: '#/components/schemas/ErrorApiResponse'
/configure-requests/estimate:
post:
tags:
- Invoice Configurations
summary: Retrieves a preview of an invoice request based on the provided configuration without persisting the request.
requestBody:
description: The invoice configuration request containing settings to preview.
content:
application/json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationRequest'
example: "{\n \"Name\": \"Monthly Invoice Run - January 2026\",\n \"RunType\": \"Immediate\",\n \"AutoApproveInvoices\": true,\n \"Status\": \"Draft\",\n \"InvoiceDateType\": \"Ready for Invoice Date\",\n \"ProcessFrom\": \"2025-06-15T00:00:00\",\n \"ProcessTo\": \"2026-08-20T00:00:00\",\n \"FilterCriteria\": {\n \"ParentOperator\": \"AND\",\n \"Rules\": [\n {\n \"ObjectName\": \"Account\",\n \"ChildOperator\": \"OR\",\n \"Rules\": [\n {\n \"FieldName\": \"Name\",\n \"ComparisonOperator\": \"LIKE\",\n \"FieldType\": \"STRING\",\n \"FieldValue\": \"Acme%\"\n },\n {\n \"FieldName\": \"AccountNumber\",\n \"ComparisonOperator\": \"IN\",\n \"FieldType\": \"STRING\",\n \"FieldValue\": [\n \"ACC-001\",\n \"ACC-002\",\n \"ACC-003\"\n ]\n }\n ]\n },\n {\n \"ObjectName\": \"Product\",\n \"ChildOperator\": \"AND\",\n \"Rules\": [\n {\n \"FieldName\": \"IsActive\",\n \"ComparisonOperator\": \"=\",\n \"FieldType\": \"BOOLEAN\",\n \"FieldValue\": true\n },\n {\n \"FieldName\": \"ProductFamily\",\n \"ComparisonOperator\": \"=\",\n \"FieldType\": \"PICKLIST\",\n \"FieldValue\": \"Subscription\"\n }\n ]\n },\n {\n \"ObjectName\": \"BillingScheduleRecord\",\n \"ChildOperator\": \"AND\",\n \"Rules\": [\n {\n \"FieldName\": \"ReadyForInvoiceDate\",\n \"ComparisonOperator\": \"\\u003E=\",\n \"FieldType\": \"DATE\",\n \"FieldValue\": \"2025-01-01\"\n },\n {\n \"FieldName\": \"NetPrice\",\n \"ComparisonOperator\": \"\\u003E\",\n \"FieldType\": \"CURRENCY\",\n \"FieldValue\": 100\n }\n ]\n }\n ]\n },\n \"FilterCriteriaOld\": null,\n \"CreateCreditMemos\": true,\n \"CreditMemoCreationOption\": \"One Per Negative Billing Schedule\",\n \"InvoiceDate\": null,\n \"CreditMemoDateBasedOn\": \"Ready for Invoice Date\",\n \"CreditMemoDate\": null,\n \"AutoApproveAmountOperator\": \"Less than or equal to\",\n \"AutoApproveAmount\": {\n \"Value\": 10000,\n \"DisplayValue\": 0,\n \"CurrencyCode\": null,\n \"CurrencySymbol\": null\n },\n \"SuppressCriterion\": \"Amount\",\n \"SuppressOperator\": \"Less than\",\n \"SuppressInvoiceAmount\": {\n \"Value\": 10,\n \"DisplayValue\": 0,\n \"CurrencyCode\": null,\n \"CurrencySymbol\": null\n },\n \"AutoApplyCreditMemo\": true,\n \"AutoApproveCreditMemos\": true,\n \"Frequency\": \"Monthly by Date\",\n \"WeekOfTheMonth\": \"The 1st\",\n \"WeekDay\": [\n \"Monday\"\n ],\n \"InvoiceDayReference\": \"Last\",\n \"InvoiceMonthReference\": \"Current Month\",\n \"InvoiceDateOffset\": \"0\",\n \"ProcessThroughOffset\": \"0\",\n \"StartHour\": \"00\",\n \"StartMinute\": \"00\",\n \"OverwriteInvoiceTemplates\": true,\n \"InvoiceDocumentTemplate\": {\n \"Name\": \"Standard Invoice Template\"\n },\n \"InvoiceEmailTemplate\": {\n \"Name\": \"Invoice Email Template\"\n },\n \"OverwriteCreditMemoTemplates\": true,\n \"CreditMemoDocumentTemplate\": {\n \"Name\": \"Standard Credit Memo Template\"\n },\n \"CreditMemoEmailTemplate\": {\n \"Name\": \"Credit Memo Email Template\"\n },\n \"SplitCriteria\": null,\n \"MonthlyDate\": null,\n \"ProcessFromDayReference\": null,\n \"ProcessFromMonthReference\": null,\n \"ProcessToDayReference\": null,\n \"ProcessToMonthReference\": null,\n \"ProcessFromOffset\": null,\n \"ScheduleFrom\": null,\n \"ScheduleTo\": null\n}"
text/json:
schema:
$ref: '#/components/schemas/InvoiceConfigurationRequest'
example: "{\n \"Name\": \"Monthly Invoice Run - January 2026\",\n \"RunType\": \"Immediate\",\n \"AutoApproveInvoices\": true,\n \"Status\": \"Draft\",\n \"InvoiceDateType\": \"Ready for Invoice Date\",\n \"ProcessFrom\": \"2025-06-15T00:00:00\",\n \"ProcessTo\": \"2026-08-20T00:00:00\",\n \"FilterCriteria\": {\n
# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-invoice-configurations-api-openapi.yml