# Save Billing Profile

Save Billing Profile

Endpoint: POST /rest/2.0/BILLING_PROFILE
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.DisablePDFGenerationOnInvoiceClose` (integer)
    Disable PDF Generation on Invoice Close: When this option is selected, no invoice PDF will be generated during the invoice close process. If an invoice PDF is needed after invoice close, users can navigate to the invoice page to generate the PDF utilizing the Invoice Template defined at the Account

  - `brmObjects.SemiAnnualBillingMonth` (string, required)
    Billing Cycle Closing Month

  - `brmObjects.Attention` (string)
    Attn

  - `brmObjects.MonthlyBillingDate` (string, required)
    Billing Cycle Closing Day

  - `brmObjects.CreditCardExpDate` (string)
    Credit Card Exp Date (MM/YYYY)

  - `brmObjects.Address1` (string, required)
    Addr1

  - `brmObjects.Address2` (string)
    Addr2

  - `brmObjects.Country` (string)
    Country

  - `brmObjects.City` (string)
    City

  - `brmObjects.State` (string)
    State

  - `brmObjects.Zip` (string)
    Zip

  - `brmObjects.Phone` (string)
    Phone

  - `brmObjects.Fax` (string)
    Fax

  - `brmObjects.Email` (string)
    Email: Specify the email address to which invoices are addressed. Invoices will not be sent to the specified email address until EMAIL is selected for the Invoice Delivery Method under Billing Profile Information.

  - `brmObjects.TimeZoneId` (string, required)
    Invoicing Time Zone: Specifies the time zone used for invoice close, rate start/ end, and service start/end time.

  - `brmObjects.InvGraceDaysBeforeClosing` (string)
    InvGraceDaysBeforeClosing: Invoice Grace before Close

  - `brmObjects.PaymentTermDays` (string, required)
    Payment Terms (Net): Indicates the number of days from when the invoice is closed to when the payment is expected. This is the same as the 'Payment Due Date' sections of common subscription invoices. If a customer has a default credit card or direct debit payment method saved for payments, the system will attempt to process the payment via the default payment method after the # of days indicated in the field lapses.

  - `brmObjects.BillingMethod` (string, required)
    Payment Method: This is the method of accepting payments into the account. Additional fields will become available to fill up depending on the type of method selected (i.e., credit card information, checking information, etc.)

  - `brmObjects.BillingCycle` (string, required)
    Default Billing Cycle: Indicates the default billing cycle that will be used for the account. This can be overridden if event-based billing is enabled.

  - `brmObjects.BillTo` (string, required)
    Bill To: Indicates the name to which bills are addressed to. This is what typically appears on the invoice PDFs that are generated out of the system.

  - `brmObjects.InvoiceTemplateId` (integer, required)
    Invoice Template

  - `brmObjects.CreditCardType` (string)
    Credit Card Type

  - `brmObjects.CreditCardName` (string)
    Card Holder Name

  - `brmObjects.CreditCardNumber` (string)
    Credit Card Number

  - `brmObjects.CreditCardCCV` (string)
    Credit Card CCV

  - `brmObjects.ManualCloseFlag` (integer)
    Manual Closing: Indicates whether the invoices generated after the billing cycle require manual closing.If selected, invoices remain in the Current status after the billing period ends. The closing action must be triggered manually.If not selected (default), invoices are automatically closed on their close date.

  - `brmObjects.StatementCycle` (string)
    Statement Cycle

  - `brmObjects.StatementTemplateId` (string)
    Statement Template

  - `brmObjects.DunningInterval` (string)
    Dunning Process: Select a dunning strategy to use on this account should it become delinquent.

  - `brmObjects.InvoiceDeliveryMethod` (string)
    Invoice Delivery Method: Select how the invoice is delivered to the account. Choose between Mail or Email.

  - `brmObjects.Id` (string, required)
    Own Billing Profile Id: BILLING_PROFILE_ID

  - `brmObjects.AccountId` (integer, required)
    Account Id: Account

  - `brmObjects.Status` (string, required)
    Status

  - `brmObjects.CalendarType` (string, required)
    Calendar Type

  - `brmObjects.CalendarClosingMonth` (string, required)
    Calendar Closing Month

  - `brmObjects.CalendarClosingWeekday` (string, required)
    Billing Cycle Closing Weekday

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `brmObjects.StatementApprovalFlag` (integer)
    Approve Statements Before Delivery

  - `brmObjects.InvoiceApprovalFlag` (integer)
    Approve invoices before delivery

  - `brmObjects.EventGroupType` (string)
    Close Invoice every

  - `brmObjects.PoNumber` (string)
    PO Number

  - `brmObjects.InvoiceFileFormat` (string)
    Invoice File Format: Specify a file format to override the default format from the invoice template. Leave this field empty to use the template's format.

  - `brmObjects.AllowPricingInOtherCurrency` (integer)
    Allow Pricing In Different Currency

  - `brmObjects.CreditCardToken` (string)
    CreditCardToken

  - `brmObjects.BillingEntity` (string)
    BillingEntity: Billnge Entity

  - `brmObjects.AchBankAcctType` (string)
    ACH Account Type

  - `brmObjects.AchBankAbaCode` (string)
    ACH Routing Number

  - `brmObjects.AchBankAcctName` (string)
    ACH Name on Account

  - `brmObjects.AchBankAcctNum` (string)
    ACH Account Number

  - `brmObjects.WeeklyBillingDate` (string)
    Bill Cycle Schedule

  - `brmObjects.AchBankName` (string)
    ACH Bank Name

  - `brmObjects.AchEcheckType` (string)
    ACH Echeck Type

  - `brmObjects.PeriodCutoffDate` (string)
    Period Cutoff Date: Billable transactions can`t be booked prior to this date. This date is advanced or retreated by opening or closing invoice periods

  - `brmObjects.TaxEngineId` (integer)
    Tax Engine

  - `brmObjects.PaymentGatewayCustomerId` (string)
    Payment Gateway Customer Extenal Key

  - `brmObjects.AchMandateEnabledFlag` (integer)
    AchMandateEnabledFlag: Mandate Enabled Flag

  - `brmObjects.AchMandateStatus` (string)
    Mandate Status

  - `brmObjects.AchMandateStatusModifyDate` (string)
    AchMandateStatusModifyDate: Mandate Status Modify Date

  - `brmObjects.AchScheme` (string)
    Direct Debit Scheme

  - `brmObjects.AchBranchCode` (string)
    Branch Code

  - `brmObjects.AchMandateCountry` (string)
    Mandate Country

  - `brmObjects.AchMandateState` (string)
    Mandate State

  - `brmObjects.NationalIdentityNumber` (string)
    National Identity Number

  - `brmObjects.HostedPaymentPageExternalId` (string)
    HostedPaymentPage External Id

  - `brmObjects.CustomerRefNum` (string)
    CustomerRefNum: Customer Reference Number

  - `brmObjects.StatementEarliestDate` (string)
    Statement Earliest Date: When this date is set, no statement will be generated until this date

  - `brmObjects.YearlyBillingMonth` (string)
    Billing Cycle Closing Month: For quarterly and annual invoices specifies the month in which invoice close will happen

  - `brmObjects.QuarterlyBillingMonth` (string)
    Billing Cycle Closing Month: For quarterly and annual invoices specifies the month in which invoice close will happen

  - `brmObjects.PaymentCreditAllocationMethod` (string, required)
    Payment and Credit Allocation Method: This setting defines the method used to allocate payments and credits to invoices for the Account. When the field is set to 'Allocate To Invoice' the system will enable payments and credits to be allocated at the invoice level for the account. When set to 'Allocate To Invoice Detail' the system will enable payments and credits to be allocated to individual Invoice Details

  - `brmObjects.EInvoiceProfile` (integer)
    E-invoice Profile

  - `brmObjects.EInvoiceTemplate` (integer)
    E-invoice Template

  - `brmObjects.ECreditTemplate` (integer)
    E-invoice Credit Template

  - `brmObjects.AchMandateReference` (string)
    Mandate Reference

  - `brmObjects.CurrencyCode` (integer, required)
    Invoice Currency: Specifies the currency applied to invoices. Changing the value of this field triggers a re-rate of current invoices to the new currency.

  - `brmObjects.StatementDeliveryMethod` (string)
    Statement Delivery Method

  - `brmObjects.EventBasedBilling` (integer)
    Allow Event Based Billing

  - `brmObjects.AchUniqueRef` (string)
    Unique Reference

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.DisablePDFGenerationOnInvoiceClose` (integer)
    Disable PDF Generation on Invoice Close: When this option is selected, no invoice PDF will be generated during the invoice close process. If an invoice PDF is needed after invoice close, users can navigate to the invoice page to generate the PDF utilizing the Invoice Template defined at the Account

  - `retrieveResponse.SemiAnnualBillingMonth` (string)
    Billing Cycle Closing Month

  - `retrieveResponse.Attention` (string)
    Attn

  - `retrieveResponse.MonthlyBillingDate` (string)
    Billing Cycle Closing Day

  - `retrieveResponse.CreditCardExpDate` (string)
    Credit Card Exp Date (MM/YYYY)

  - `retrieveResponse.Address1` (string)
    Addr1

  - `retrieveResponse.Address2` (string)
    Addr2

  - `retrieveResponse.Country` (string)
    Country

  - `retrieveResponse.City` (string)
    City

  - `retrieveResponse.State` (string)
    State

  - `retrieveResponse.Zip` (string)
    Zip

  - `retrieveResponse.Phone` (string)
    Phone

  - `retrieveResponse.Fax` (string)
    Fax

  - `retrieveResponse.Email` (string)
    Email: Specify the email address to which invoices are addressed. Invoices will not be sent to the specified email address until EMAIL is selected for the Invoice Delivery Method under Billing Profile Information.

  - `retrieveResponse.TimeZoneId` (string)
    Invoicing Time Zone: Specifies the time zone used for invoice close, rate start/ end, and service start/end time.

  - `retrieveResponse.InvGraceDaysBeforeClosing` (string)
    InvGraceDaysBeforeClosing: Invoice Grace before Close

  - `retrieveResponse.PaymentTermDays` (string)
    Payment Terms (Net): Indicates the number of days from when the invoice is closed to when the payment is expected. This is the same as the 'Payment Due Date' sections of common subscription invoices. If a customer has a default credit card or direct debit payment method saved for payments, the system will attempt to process the payment via the default payment method after the # of days indicated in the field lapses.

  - `retrieveResponse.BillingMethod` (string)
    Payment Method: This is the method of accepting payments into the account. Additional fields will become available to fill up depending on the type of method selected (i.e., credit card information, checking information, etc.)

  - `retrieveResponse.BillingCycle` (string)
    Default Billing Cycle: Indicates the default billing cycle that will be used for the account. This can be overridden if event-based billing is enabled.

  - `retrieveResponse.BillTo` (string)
    Bill To: Indicates the name to which bills are addressed to. This is what typically appears on the invoice PDFs that are generated out of the system.

  - `retrieveResponse.InvoiceTemplateId` (integer)
    Invoice Template

  - `retrieveResponse.CreditCardType` (string)
    Credit Card Type

  - `retrieveResponse.CreditCardName` (string)
    Card Holder Name

  - `retrieveResponse.CreditCardNumber` (string)
    Credit Card Number

  - `retrieveResponse.CreditCardCCV` (string)
    Credit Card CCV

  - `retrieveResponse.ManualCloseFlag` (integer)
    Manual Closing: Indicates whether the invoices generated after the billing cycle require manual closing.If selected, invoices remain in the Current status after the billing period ends. The closing action must be triggered manually.If not selected (default), invoices are automatically closed on their close date.

  - `retrieveResponse.StatementCycle` (string)
    Statement Cycle

  - `retrieveResponse.StatementTemplateId` (string)
    Statement Template

  - `retrieveResponse.DunningInterval` (string)
    Dunning Process: Select a dunning strategy to use on this account should it become delinquent.

  - `retrieveResponse.InvoiceDeliveryMethod` (string)
    Invoice Delivery Method: Select how the invoice is delivered to the account. Choose between Mail or Email.

  - `retrieveResponse.Id` (string)
    Own Billing Profile Id: BILLING_PROFILE_ID

  - `retrieveResponse.AccountId` (integer)
    Account Id: Account

  - `retrieveResponse.Status` (string)
    Status

  - `retrieveResponse.CalendarType` (string)
    Calendar Type

  - `retrieveResponse.CalendarClosingMonth` (string)
    Calendar Closing Month

  - `retrieveResponse.CalendarClosingWeekday` (string)
    Billing Cycle Closing Weekday

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.StatementApprovalFlag` (integer)
    Approve Statements Before Delivery

  - `retrieveResponse.InvoiceApprovalFlag` (integer)
    Approve invoices before delivery

  - `retrieveResponse.EventGroupType` (string)
    Close Invoice every

  - `retrieveResponse.PoNumber` (string)
    PO Number

  - `retrieveResponse.InvoiceFileFormat` (string)
    Invoice File Format: Specify a file format to override the default format from the invoice template. Leave this field empty to use the template's format.

  - `retrieveResponse.AllowPricingInOtherCurrency` (integer)
    Allow Pricing In Different Currency

  - `retrieveResponse.CreditCardToken` (string)
    CreditCardToken

  - `retrieveResponse.BillingEntity` (string)
    BillingEntity: Billnge Entity

  - `retrieveResponse.AchBankAcctType` (string)
    ACH Account Type

  - `retrieveResponse.AchBankAbaCode` (string)
    ACH Routing Number

  - `retrieveResponse.AchBankAcctName` (string)
    ACH Name on Account

  - `retrieveResponse.AchBankAcctNum` (string)
    ACH Account Number

  - `retrieveResponse.WeeklyBillingDate` (string)
    Bill Cycle Schedule

  - `retrieveResponse.AchBankName` (string)
    ACH Bank Name

  - `retrieveResponse.AchEcheckType` (string)
    ACH Echeck Type

  - `retrieveResponse.PeriodCutoffDate` (string)
    Period Cutoff Date: Billable transactions can`t be booked prior to this date. This date is advanced or retreated by opening or closing invoice periods

  - `retrieveResponse.TaxEngineId` (integer)
    Tax Engine

  - `retrieveResponse.PaymentGatewayCustomerId` (string)
    Payment Gateway Customer Extenal Key

  - `retrieveResponse.AchMandateEnabledFlag` (integer)
    AchMandateEnabledFlag: Mandate Enabled Flag

  - `retrieveResponse.AchMandateStatus` (string)
    Mandate Status

  - `retrieveResponse.AchMandateStatusModifyDate` (string)
    AchMandateStatusModifyDate: Mandate Status Modify Date

  - `retrieveResponse.AchScheme` (string)
    Direct Debit Scheme

  - `retrieveResponse.AchBranchCode` (string)
    Branch Code

  - `retrieveResponse.AchMandateCountry` (string)
    Mandate Country

  - `retrieveResponse.AchMandateState` (string)
    Mandate State

  - `retrieveResponse.NationalIdentityNumber` (string)
    National Identity Number

  - `retrieveResponse.HostedPaymentPageExternalId` (string)
    HostedPaymentPage External Id

  - `retrieveResponse.CustomerRefNum` (string)
    CustomerRefNum: Customer Reference Number

  - `retrieveResponse.StatementEarliestDate` (string)
    Statement Earliest Date: When this date is set, no statement will be generated until this date

  - `retrieveResponse.YearlyBillingMonth` (string)
    Billing Cycle Closing Month: For quarterly and annual invoices specifies the month in which invoice close will happen

  - `retrieveResponse.QuarterlyBillingMonth` (string)
    Billing Cycle Closing Month: For quarterly and annual invoices specifies the month in which invoice close will happen

  - `retrieveResponse.PaymentCreditAllocationMethod` (string)
    Payment and Credit Allocation Method: This setting defines the method used to allocate payments and credits to invoices for the Account. When the field is set to 'Allocate To Invoice' the system will enable payments and credits to be allocated at the invoice level for the account. When set to 'Allocate To Invoice Detail' the system will enable payments and credits to be allocated to individual Invoice Details

  - `retrieveResponse.EInvoiceProfile` (integer)
    E-invoice Profile

  - `retrieveResponse.EInvoiceTemplate` (integer)
    E-invoice Template

  - `retrieveResponse.ECreditTemplate` (integer)
    E-invoice Credit Template

  - `retrieveResponse.AchMandateReference` (string)
    Mandate Reference

  - `retrieveResponse.CurrencyCode` (integer)
    Invoice Currency: Specifies the currency applied to invoices. Changing the value of this field triggers a re-rate of current invoices to the new currency.

  - `retrieveResponse.StatementDeliveryMethod` (string)
    Statement Delivery Method

  - `retrieveResponse.EventBasedBilling` (integer)
    Allow Event Based Billing

  - `retrieveResponse.AchUniqueRef` (string)
    Unique Reference

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error