Skip to content
This repository was archived by the owner on Oct 17, 2023. It is now read-only.

Latest commit

 

History

History
17 lines (14 loc) · 3.09 KB

File metadata and controls

17 lines (14 loc) · 3.09 KB

Bfwd::AddChargesToAccountAPIRequest

Properties

Name Type Description Notes
name String {"description":"Friendly name given to any Invoice immediately produced when adding charges.","verbs":["POST","GET"]} [optional]
purchase_order String {"description":"Purchase order associated with any Invoice immediately produced when adding charges.","verbs":["POST","GET"]} [optional]
description String {"description":"Description to apply to any Invoice immediately produced when adding charges","verbs":["POST","GET"]} [optional]
currency String {"description":"Currency of the charges raised, specified by a three-character ISO 4217 currency code.","verbs":["GET"]} [optional]
payment_terms Integer {"description":"Defines the 'payment terms' for any Invoice generated as a result of this action. Number of days after the issued date that the invoice is due. Payment will be attempted regardless of the payment terms. Payment terms are all Net.","verbs":["GET"]} [optional]
remaining_credit_behaviour String {&quot;default&quot;:&quot;<span class=\&quot;label label-default\&quot;>Rollover</span>&quot;,&quot;description&quot;:&quot;Defines the behaviour applied to any outstanding credit resulting from the application of the charge.<br><span class=\&quot;label label-default\&quot;>Rollover</span> &mdash; Outstanding credit is returned to the accounts credit pool.<br><span class=\&quot;label label-default\&quot;>Discard</span> &mdash; Outstanding credit is lost.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]
invoice_state String {&quot;default&quot;:&quot;Pending&quot;,&quot;description&quot;:&quot;Stipulates the state of the resulting adhoc invoice if the invoicing type is Immediate&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]
charges Array<NestedChargeRequest> {&quot;description&quot;:&quot;The charges which shall be added to the Account.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]
dry_run BOOLEAN {&quot;default&quot;:&quot;false&quot;,&quot;description&quot;:&quot;Calculate the effects of adding charges to an Account, but do not actually persist any changes.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]
void_on_failure BOOLEAN {&quot;default&quot;:true,&quot;description&quot;:&quot;If we have created an adhoc invoice and it has had an unsuccessful payment attempt, should we void it&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]