varyContractBilling

varyContractBilling

Overview

This method modifies the future billings for a contract that has started billing.

For a contract that has not yet billed, use editContractBilling.

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

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'ContractBilling:Vary'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/fm/contract/billing/vary https://api.{{environment}}.catch-e.com/fm/contract/billing/vary https://api.test.catch-e.com/fm/contract/billing/vary

Input Fields (Header)

Key

Format

Notes

Mandatory

Delegated-Locking-Session-Id

string

(Optional) Locking responsibility will be delegated to the specified Session Id. The API will only verify that locks exist for this session id, and will not obtain them itself. Requires the DelegatedLocking permission.

No

Audit-User-Id

string

(Optional) User Id to use for audit purposes. Up to 5 digits. Requires the Audit:UserIdOverride permission.

No

Input Fields (JSON)

Key

Format

Notes

Mandatory

contract_id

string

Contract Id.

Yes

posting_map_id

string

Posting Map Id.

No

term

number

Contract term, in months.

No

contract_start

string (date)

Contract start date, in yyyy-MM-dd format.

No

contract_end

string (date)

Contract end date, in yyyy-MM-dd format.

No

inertia_flag

string

Determines the contract's FBT days calculations. Allowed values: yes, no.

No

billing_interval

string

A valid pay cycle code.

No

billing_deferred

number

The number of periods deferred.

No

remaining_billing_periods

integer

Additional billing periods to create.

No

next_billing_date

string

Date of the next budget period to bill.

No

billing_common_day

string

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

No

payment_method

string

Payment method preference for budgets. Allowed values: direct-debit, cheque, cash, other, credit-card, eft.

No

override_warnings_flag

string

Override warning validation. Allowed values: yes, no. Default no.

No

Example

{ "contract_id": "5678", "term": 60, "contract_end": "2031-01-31", "remaining_billing_periods": 26, "billing_interval": "fortnightly" }

Response Details

Success

201 - Created

Field

Format

Notes

result

string

The result of the request.

{ "result": "string" }

Error Response Details

Validation Message

Comments

401 - Unauthorized

1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Validation Message

Comments

403 - Forbidden

- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

Validation Message

Comments

404 - Not Found

The contract does not exist.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Found", "status": 404, "detail": "Not Found" }

Validation Message

Comments

406 - Not Acceptable

The Accept header of the request does not match a response format this API supports.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

Validation Message

Comments

415 - Unsupported Media Type

The Content-Type of the request is not supported by this API.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unsupported Media Type", "status": 415, "detail": "Not Acceptable" }

Validation Message

Comments

422 - Unprocessable Entity

One or more input fields failed validation. The field name and message are returned in validation_messages.

{ "warning_messages": {}, "validation_messages": { "fieldName": { "validationExceptionCode": "A textual description of the validation exception" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Validation Message

Comments

423 - Locked

The record is locked by another process or user.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Locked", "status": 423, "detail": "Locked" }

Validation Message

Comments

424 - Failed Dependency

Lock expected. A Delegated-Locking-Session-Id was supplied, but the expected lock for that session was not found.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Failed Dependency", "status": 424, "detail": "Failed Dependency" }

Validation Message

Comments

500 - Internal Error

An unexpected error occurred on the server.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Validation Message

Comments

default - Unexpected Error

Any other unexpected error.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }