# 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.AccountId` (any, required)
    Account Id: Account

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

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

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

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

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

  - `brmObjects.AchBranchCode` (any)
    Branch Code

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

  - `brmObjects.AchMandateCountry` (any)
    Mandate Country

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

  - `brmObjects.AchMandateReference` (any)
    Mandate Reference

  - `brmObjects.AchMandateState` (any)
    Mandate State

  - `brmObjects.AchMandateStatus` (any)
    Mandate Status

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

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

  - `brmObjects.AchUniqueRef` (any)
    Unique Reference

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

  - `brmObjects.Address2` (any)
    Addr2

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

  - `brmObjects.Attention` (any)
    Attn

  - `brmObjects.BillTo` (any, 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.BillingCycle` (any, 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.BillingEntity` (any)
    BillingEntity: Billnge Entity

  - `brmObjects.BillingMethod` (any, 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.CalendarClosingMonth` (any, required)
    Calendar Closing Month

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

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

  - `brmObjects.City` (any)
    City

  - `brmObjects.Country` (any)
    Country

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

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

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

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

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

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

  - `brmObjects.CreditCardToken` (any)
    CreditCardToken

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

  - `brmObjects.CurrencyCode` (any, 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.CustomerRefNum` (any)
    CustomerRefNum: Customer Reference Number

  - `brmObjects.DisablePDFGenerationOnInvoiceClose` (any)
    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.DunningInterval` (any)
    Dunning Process: Select a dunning strategy to use on this account should it become delinquent.

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

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

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

  - `brmObjects.Email` (any)
    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.EventBasedBilling` (any)
    Allow Event Based Billing

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

  - `brmObjects.Fax` (any)
    Fax

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

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

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

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

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

  - `brmObjects.InvoiceFileFormat` (any)
    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.InvoiceTemplateId` (any, required)
    Invoice Template

  - `brmObjects.ManualCloseFlag` (any)
    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.MonthlyBillingDate` (any, required)
    Billing Cycle Closing Day

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

  - `brmObjects.PaymentCreditAllocationMethod` (any, 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.PaymentGatewayCustomerId` (any)
    Payment Gateway Customer Extenal Key

  - `brmObjects.PaymentTermDays` (any, 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.PeriodCutoffDate` (any)
    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.Phone` (any)
    Phone

  - `brmObjects.PoNumber` (any)
    PO Number

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

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

  - `brmObjects.State` (any)
    State

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

  - `brmObjects.StatementCycle` (any)
    Statement Cycle

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

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

  - `brmObjects.StatementTemplateId` (any)
    Statement Template

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

  - `brmObjects.TaxEngineId` (any)
    Tax Engine

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

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

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

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

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

  - `brmObjects.Zip` (any)
    Zip

## Response 200 fields (application/json):

  - `createResponse` (array)

  - `createResponse.Id` (any)

  - `createResponse.success` (boolean)

  - `createResponse.ErrorText` (string)

  - `createResponse.ErrorElementField` (string)

## 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