Contract / Billing

Modify future billings for a contract that has started billing

This method requires the ContractBilling:Vary permission to be associated with your role.

POST

/fm/contract/billing/vary

curl --request POST \
  --url https://api.catch-e.com/fm/contract/billing/vary \
  --header 'Authorization: <api-key>' \
  --header 'Delegated-Locking-Session-Id: <string>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing_common_day": "1",
  "billing_deferred": 0,
  "billing_interval": "monthly",
  "contract_end": "YYYY-MM-DD",
  "contract_id": "100000",
  "contract_start": "YYYY-MM-DD",
  "inertia_flag": "no",
  "next_billing_date": "YYYY-MM-DD",
  "override_alignment_warning_flag": "no",
  "override_warnings_flag": "no",
  "payment_method": "direct-debit",
  "posting_map_id": "100000",
  "remaining_billing_periods": 10,
  "term": 60
}
'

{
  "result": "OK"
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Headers

Delegated-Locking-Session-Idstringheader

(Optional) Locking responsibility will be delegated to the specified Session Id.

This header enables the client to instruct the API to merely verify the presence of locks with the specified session id, but not attempt to obtain them itself. It requires the DelegatedLocking permission to be associated with your role.

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

Pattern: ^[1-9]{1}[0-9]*$

Body

JSON payload

billing_common_daystring

For monthly billing, select the day of the month charges will be due, or 'eom' for end of month

Example: 1

billing_deferrednumber

The number of periods deferred

Example: 0

billing_intervalstring

A valid pay cycle code

Example: monthly

contract_endstring

Contract End Date

Example: YYYY-MM-DD

contract_idstringrequired

Contract Id

Example: 100000

contract_startstring

Contract Start Date

Example: YYYY-MM-DD

inertia_flagenum<string>

Determines the contract's FBT days calculations

Available options: yes, no

Example: no

next_billing_datestring

Date of the next budget period to bill

Example: YYYY-MM-DD

override_alignment_warning_flagenum<string>

For a direct-link novated contract only: acknowledges that the billing date does not align to the client's payroll date for this pay cycle (or that the client has no payroll date configured for it) so the save proceeds without creating pay run records. Does not satisfy override_warnings_flag, and override_warnings_flag does not satisfy this. If not specified, defaults to 'no'.

Available options: yes, no

Example: no

override_warnings_flagenum<string>

Override warning validation. If not specified, defaults to 'no'

Available options: yes, no

Example: no

payment_methodenum<string>

Payment method preference for budgets

Available options: direct-debit, cheque, cash, other, credit-card, eft

Example: direct-debit

posting_map_idstring

Posting Map Id

Example: 100000

remaining_billing_periodsinteger

Additional billing periods to create

Example: 10

termnumber

Contract Term (in months)

Example: 60

Response

Success

resultstring

Example: OK

Still need help? Ask the team