afv-library/skills/platform-metadata-api-context-get/assets/metadata_api/BillingSettings.json

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "BillingSettings - Metadata API",
  "description": "Represents the settings for Salesforce Billing.",
  "file_information": ".settings",
  "directory_location": "settings",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "acctRecGlAccount": {
      "type": "string",
      "description": "General ledger account to record the credit amount for unrealized or realized losses and the debit amount for unrealized or realized gains in transaction journals. Available in API version 64.0 and later."
    },
    "billingContextDefinition": {
      "type": "string",
      "description": "Name of the context definition that the Create Billing Schedules for Orders API uses to understand your order data. Available in API version 64.0 and later."
    },
    "billingContextSourceMapping": {
      "type": "string",
      "description": "Name of the context mapping that links Order fields to billing transaction context nodes. Available in API version 64.0 and later."
    },
    "billingIntraCtxtSrcMapping": {
      "type": "string",
      "description": "Name of the custom context mapping that maps your custom or standard Order fields to billing transaction context nodes. Available in API version 64.0 and later."
    },
    "defaultAPClosureDPEDefnName": {
      "type": "string",
      "description": "Org-wide default value to specify the Data Processing Engine (DPE) definition to close legal entity accounting periods. Available in API version 64.0 and later."
    },
    "defaultApplyCreditMemoFlow": {
      "type": "string",
      "description": "Default flow that’s used to apply the credit memo to invoices. Available in API version 64.0 and later."
    },
    "defaultBillingTreatment": {
      "type": "string",
      "description": "Org-wide default value to specify the name of the billing treatment. Available in API version 64.0 and later."
    },
    "defaultEmailTemplate": {
      "type": "string",
      "description": "Default email template to send the generated invoice PDFs. Available in API version 64.0 and later."
    },
    "defaultInvPreviewTemplate": {
      "type": "string",
      "description": "Default template to generate PDFs of invoice previews. Available in API version 64.0 and later."
    },
    "defaultInvoiceDocTemplate": {
      "type": "string",
      "description": "Default template to generate PDFs of invoices. Available in API version 64.0 and later."
    },
    "defaultLegalEntity": {
      "type": "string",
      "description": "Org-wide default value to specify the name of the legal entity. Available in API version 64.0 and later."
    },
    "defaultTaxTreatment": {
      "type": "string",
      "description": "Org-wide default value to specify the name of the tax treatment. Available in API version 64.0 and later."
    },
    "enableBillingDisputeManagement": {
      "type": "boolean",
      "description": "Indicates whether to enable Dispute Management (true) or not (false). The default value is false. Available in API version 66.0 and later."
    },
    "enableBillingSetup": {
      "type": "boolean",
      "description": "Indicates whether to enable Billing setting (true) or not (false). The default value is false."
    },
    "enableCreditMemoSequenceService": {
      "type": "boolean",
      "description": "Indicates whether to mandate the application of sequence policy for credit memos (true) or not (false). The default value is false.Available in API version 66.0 and later with Revenue Cloud Billing."
    },
    "enableCrMemoApplicationToPostedInvoices": {
      "type": "boolean",
      "description": "Indicates whether to enable Apply Credits to Posted Invoices setting (true) or not (false). The default value is false. This setting automates settlement of invoices through application of credits to posted invoices. The credit application level determines whether credits are automatically applied to invoices or invoice lines."
    },
    "enableFailedPaymentsRetry": {
      "type": "boolean",
      "description": "Indicates whether to retry failed payment schedule items automatically based on the defined payment retry rules (true) or not (false). The default value is false. Available in API version 66.0 and later."
    },
    "enableForeignExchangeTrxnJrnlCreation": {
      "type": "boolean",
      "description": "Indicates whether to create Transaction Journal records for invoices that hold balance amounts (partially settled and not fully settled posted invoices) to record foreign exchange unrealized gains or losses during the closure activity of a legal entity accounting period. The default value is false. Available in API version 65.0 and later with Revenue Cloud Billing."
    },
    "enableInvoiceEmailDelivery": {
      "type": "boolean",
      "description": "Indicates whether to enable Configure Email Delivery Settings (true) or not (false). The default value is false. Available in API version 63.0 and later with Revenue Cloud Billing."
    },
    "enableInvoicePdfGeneration": {
      "type": "boolean",
      "description": "Indicates whether to enable Document Generation setting (true) or not (false). The default value is false. Available in API version 63.0 and later with Revenue Cloud Billing."
    },
    "enableInvoiceSequenceService": {
      "type": "boolean",
      "description": "Indicates whether to mandate the application of sequence policy for posted invoices (true) or not (false). The default value is false. If enabled, each posted invoice is assigned an invoice number. Available in API version 65.0 and later with Revenue Cloud Billing."
    },
    "enableNegInvoiceLnConversionToCrMemoLn": {
      "type": "boolean",
      "description": "Indicates whether to enable Convert Negative Invoice Lines to Credit Memo Lines setting (true) or not (false). The default value is false."
    },
    "enablePaymentSchedulesAndItemsCreation": {
      "type": "boolean",
      "description": "Indicates whether to create a default payment schedule policy and payment schedule treatment (true) or not (false). The default value is false. If enabled, payment schedules and payment schedule items are created during financial transactions such as posting of invoices. Available in API version 64.0 and later with Revenue Cloud Billing."
    },
    "enableTransactionJournalCreation": {
      "type": "boolean",
      "description": "Indicates whether to create Transaction Journal records based on the defined general ledger account assignment rules for the billing entities when billing transaction records are created or updated (true) or not (false). The default value is false. Available in API version 63.0 and later with Revenue Cloud Billing. Billing transaction records include these transaction types. Invoice Invoice Line Invoice Line Tax Credit Memo Credit Memo Line Credit Memo Line Tax Payment Refund Payment Line Invoice Payment Line Invoice Line Credit Memo Inv Application Credit Memo Line Invoice Line"
    },
    "enableTransactionsApplicationToInvoices": {
      "type": "boolean",
      "description": "Indicates whether to enable Credit Application Level setting (true) or not (false). The default value is false."
    },
    "enableTrxnAmountsStorageInCorpCurrency": {
      "type": "boolean",
      "description": "Indicates whether to allow conversion of amounts of the Invoice, Invoice Line, Credit Memo, and Credit Memo Line records to your corporate currency (true) or not (false). The default value is false. Available in API version 63.0 and later. Store the converted amounts in corporate currency-specific amount fields."
    },
    "realisedGainGlAccount": {
      "type": "string",
      "description": "Name of the general ledger account to record realized gains in transaction journals. Available in API version 64.0 and later."
    },
    "realisedLossGlAccount": {
      "type": "string",
      "description": "Name of the general ledger account to record realized losses in transaction journals. Available in API version 64.0 and later."
    },
    "ruleBasedCrAndPymtAppln": {
      "type": "string",
      "description": "Automates the settlement of the posted invoices by applying payments and credits that meet the specified application rules. The rules application level determines whether payments or credits are applied first to the invoices. The ruleset displays a list of selectable rules. Available in API version 66.0 and later."
    },
    "unrealisedGainGlAccount": {
      "type": "string",
      "description": "Name of the general ledger account to record unrealized gains in transaction journals. Available in API version 64.0 and later."
    },
    "unrealisedLossGlAccount": {
      "type": "string",
      "description": "Name of the general ledger account to record unrealized losses in transaction journals. Available in API version 64.0 and later."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"BillingSettings\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"acctRecGlAccount\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"billingContextDefinition\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"billingContextSourceMapping\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"billingIntraCtxtSrcMapping\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"defaultAPClosureDPEDefnName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"defaultApplyCreditMemoFlow\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"defaultBillingTreatment\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"defaultEmailTemplate\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"defaultFxGLDPEDefnName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"defaultInvPreviewTemplate\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"defaultInvoiceDocTemplate\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"defaultLeapReopDPEDefnName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"defaultLeapSumDPEDefnName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"defaultLegalEntity\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"defaultTaxTreatment\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"enableAutomaticRefunds\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableBillingDisputeManagement\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableBillingSetup\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableConvertedCrMemoCrMemoLnAppln\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableCrMemoApplicationToPostedInvoices\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableCreditMemoSequenceService\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableDunningOrchestration\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableEnhancedPaymentData\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableFailedPaymentsRetry\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableForeignExchangeTrxnJrnlCreation\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableInvoiceEmailDelivery\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableInvoicePdfGeneration\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableInvoiceRiskScoring\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableInvoiceSequenceService\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableMilestoneBillingForAmend\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableNegInvoiceLnConversionToCrMemoLn\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enablePaymentApplicationToPostedInvoices\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enablePaymentSchedulesAndItemsCreation\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableTransactionJournalCreation\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableTransactionsApplicationToInvoices\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableTrxnAmountsStorageInCorpCurrency\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"realisedGainGlAccount\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"realisedLossGlAccount\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"ruleBasedCrAndPymtAppln\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"sendTo\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"unrealisedGainGlAccount\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"unrealisedLossGlAccount\" minOccurs=\"0\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of a BillingSettings component.",
      "code": "<BillingSettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <enableBillingSetup>true</enableBillingSetup>\n    <enableForeignExchangeTrxnJrnlCreation>true</enableForeignExchangeTrxnJrnlCreation>\n    <enableInvoicePdfGeneration>true</enableInvoicePdfGeneration>\n    <enableTransactionsApplicationToInvoices>true</enableTransactionsApplicationToInvoices>\n    <enableCrMemoApplicationToPostedInvoices>true</enableCrMemoApplicationToPostedInvoices>\n    <enableInvoiceEmailDelivery>true</enableInvoiceEmailDelivery>\n    <enableInvoiceSequenceService>true</enableInvoiceSequenceService>\n    <enableTransactionJournalCreation>true</enableTransactionJournalCreation>\n    <enableTrxnAmountsStorageInCorpCurrency>true</enableTrxnAmountsStorageInCorpCurrency>\n    <enablePaymentSchedulesAndItemsCreation>true</enablePaymentSchedulesAndItemsCreation>\n</BillingSettings>"
    }
  ]
}