Update a billgroup

put

https://api.monetizeplatform.com/api/accounts/{accountId}/billGroups/{billGroupId}

Update a billgroup which holds the billing information for a quote in a specific account

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

billGroupId

string

required

Body Params

paymentMethodId

string | null

Unique identifier for the billgroup payment method

defaultPaymentGatewayId

string | null

Unique identifier for the payment gateway. If found empty, BE will set the default one.

contactId

string

Unique identifier for the billgroup billing contact

shippingContactId

string

Unique identifier for the BillGroup's shipping contact

customId

string | null

A user provided identifier for the billgroup

name

string

required

Name of the billgroup

billDay

int32

required

This is the specific day of the month on which the bill will be generated

netTerms

string

enum

required

Net terms of an invoice

status

string

enum

required

Billgroup status like ACTIVE, INACTIVE, CANCELED OR SUSPENDED

Allowed:

dunningProcessId

string | null

Unique identifier for the dunning process

collectInvoiceBalanceAutomatically

boolean

If you want to override the global payment configuration and prevent collection at invoice time

autoEmailInvoice

boolean

Automatically send invoice by email if true

invoiceCreation

string

enum

The invoice creation type like AUTOMATIC or MANUAL

Allowed:

invoiceDelay

int32

Delay associated with invoice creation with minimum zero and maximum two days

firstInvoiceCreationStrategy

string

enum

First invoice creation strategy when invoice is being created manually

Allowed:

ccEmails

array of strings

A list of email addresses to which the invoice will be copied

ccEmails

purchaseOrderNumber

string

The corresponding purchase order number

legalEntityId

string

Unique identifier for the legal entity. Account's legal entity will be linked if no legal entity is specified

currency

string

enum

Currency for the BillGroup. It is the ISO 4217 assigned three-digit code. If no currency is provided, the account's default currency will be set

customFields

object

addressData

vatNumber

string

The corresponding vat number

registrationNumber

string

The corresponding registration number

accountingDateCalculationStrategy

string

enum

The accounting date calculation strategy

Allowed:

linkedAccountId

string | null

Linked account ID for this bill group

billingAccountId

string | null

Billing account ID for this bill group

Headers

x-api-key

string

required

x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client

Responses

400

Bad Request

500

Internal server error. Please contact the support team.

200Update object by id