Update payment cycle details

put https://api.sandbox.mozaic.io/api/payment-cycles/{id}

Path Params

string

required

Body Params

account_id

string | null

invoice_id

string | null

fee_direction

string

Defines the direction in which fees are charged.

default (Use the platform default fee direction which is to the Payee)

payer (Fees are charged to the Payer)

payee (Fees are charged to the Payee)

split (Fees are split equally between Payer and Payee.
Any remaineder is paid by the Payee)

memo

string | null

status

string

draft

locked

processing

invoicing

cancelled

completed

completedWithErrors

failed

amount

object

original_amount

object

accounting_from

date-time | null

Accounting start date

accounting_to

date-time | null

Accounting end date

name

string | null

user_id

string | null

The user id to operate on their behalf (tenants only)

object

string | null

Responses

Response body

object

account_id

string | null

invoice_id

string | null

fee_direction

string

Defines the direction in which fees are charged.

default (Use the platform default fee direction which is to the Payee)

payer (Fees are charged to the Payer)

payee (Fees are charged to the Payee)

split (Fees are split equally between Payer and Payee.
Any remaineder is paid by the Payee)

default payer payee split

memo

string | null

status

string

draft

locked

processing

invoicing

cancelled

completed

completedWithErrors

failed

draft locked processing invoicing cancelled completed completedWithErrors failed

amount

object

currency

string | null

The currency of the amount

wallet_id

string | null

The id of the wallet to use.
If an Wallet id is not specified the platform balance is used if
the amount is less than or equal to the balance, otherwise the default
Wallet for the currency will be charged

quantity

double

The quantity of Currency to send
Note that quantity is either base units or fractional depending on the currency and wallet type

formatted_quantity

string | null

original_amount

object

currency

string | null

The currency of the amount

wallet_id

string | null

quantity

double

The quantity of Currency to send
Note that quantity is either base units or fractional depending on the currency and wallet type

formatted_quantity

string | null

fees

object

currency

string | null

The currency of the amount

wallet_id

string | null

quantity

double

The quantity of Currency to send
Note that quantity is either base units or fractional depending on the currency and wallet type

formatted_quantity

string | null

accounting_from

date-time | null

Accounting start date

accounting_to

date-time | null

Accounting end date

from

object

A lightweight object for specifying 'to' and 'from' addresses
and other forms of general contact

handle

string | null

The Mozaic handle for a contact

string | null

The email address of the contact

phone

string | null

The fully qualified phone number of the contact

name

string

required

Loosely, the name of the contact. May be changed during registration

persona_id

string | null

Specifies the persona associated with this contact record

user_id

string | null

Specifies the user associated with this contact record

user_account_id

string | null

Specifies the user account id associated with this contact record

is_accepted_contact

boolean

Specifies whether this contact is in network or out of network

short_id

string | null

created_at

date-time

total_entries

int32

payment_date

date-time | null

name

string | null

short_id

string | null

created_at

date-time

Language

Credentials


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.sandbox.mozaic.io/api/payment-cycles/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/*+json'

Choose an example:

text/plain

application/json

text/json

200Success

404Not Found

500Server Error