v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Customers

Executes the Change action for the Customers data object.

Changes an existing AR Customer record, updating only the properties provided.

post/direct/subscribers/{subscriber_code}/vista/ar/2/data/customers/actions/change

Path parameters

subscriber_codestring required

The code of the subscriber that you are making this request for.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Request body

ARCointeger required

AR Company.

Namestring

SortNamestring

TempYN'Y' | 'N'

Temporary Customer.

Statusstring

Options: A-Active, I-Inactive, H-OnHold.

RecTypeinteger nullable

Key to ar/receivable_types(ARCo, RecType). Receivable Type as found in AR Receivable Types program. Optional. If omitted, ar/company_parameters.RecType will be defaulted.

PayTermsstring nullable

Key to hq/payment_terms(PayTerms). Optional. If omitted, null will be defaulted.

TaxCodestring nullable

Key to hq/tax_codes(TaxGroup, TaxCode) TaxGroup is pulled form the existing record and cannot be changed. You must provide a TaxCode for the records current TaxGroup.

MiscDistCodestring nullable

Key to ar/distribution_codes(CustGroup, MiscDistCode). CustGroup as configured in hq/company_parameters. Optional. If omitted, null will be defaulted.

DateOpenedstring date nullable

Format: YYYY-MM-DD.

CreditLimitstring

SelPurge'Y' | 'N'

Set to Y to retain Customer Transaction detail during purge operations.

StmntPrint'Y' | 'N'

StmtTypestring

Options: O-Open Item, B-Balance Forward.

FCTypestring

Options: A-Account, I-Invoice, R-RecType, N-No Finance Charges. I-Invoice is only allowed for StmtType = O-Open.

FCPctstring

Finance Charge percent. 0.90 = 90%. 1.0 max value.

ExclContFromFC'Y' | 'N'

Exclude Contract Invoices from Finance Charge.

MarkupDiscPctstring

0.90 = 90%. 1.0 max value.

Notesstring nullable

MiscOnInv'Y' | 'N'

Miscellaneous Distributions on Invoice.

MiscOnPay'Y' | 'N'

Miscellaneous Distributions on Payment.

ABNstring nullable

[PROTECTED FIELD] Australian Business Number. Should only be set if hq/company_parameters.DefaultCountry = AU for the provided ARCo.

ACNstring nullable

[PROTECTED FIELD] Australian Corporate Number. Should only be set if hq/company_parameters.DefaultCountry = AU for the provided ARCo.

__custom_fieldsobject

Add properties to this object for any custom fields you want to change as this record is updated in Vista.

Response

Success

idstring

operationstring

statusstring