Sign in

v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Customers

Executes the Add action for the Customers data object.

Adds a new customer record.

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

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 required
SortNamestring

Optional, if omitted This value will be calculated based on Vista defaulting logic with trailing digits incase of non unique results.

TempYN'Y' | 'N'

Temporary Customer. Optional. If not provided, N will be defaulted.

Statusstring

Options: A-Active, I-Inactive, H-OnHold. Optional. If Omitted, A-Active will be defaulted.

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 based on the Provided ARCo. Optional. If omitted, null will be defaulted.

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. Optional. If omitted, today will be defaulted.

CreditLimitstring

Optional. If omitted, 0 will be defaulted.

SelPurge'Y' | 'N'

Set to Y to retain Customer Transaction detail during purge operations. Optional. If omitted, N will be defaulted.

StmntPrint'Y' | 'N'

Optional. If omitted, Y will be defaulted.

StmtTypestring

Options: O-Open Item, B-Balance Forward. Optional. If not provided, O-Open Item will be defaulted.

FCTypestring

Options: A-Account, I-Invoice, R-RecType, N-No Finance Charges. I-Invoice is only allowed for StmtType = O-Open. Optional. If omitted, N-No Finance Charges will be defaulted.

FCPctstring

Finance Charge percent. 0.90 = 90%. 1.0 max value. Optional. If omitted, will be defaulted based on Vista defaulting logic.

ExclContFromFC'Y' | 'N'

Exclude Contract Invoices from Finance Charge. Optional. If omitted, N will be defaulted.

MarkupDiscPctstring

0.90 = 90%. 1.0 max value. Optional. If omitted, 0 will be defaulted.

Notesstring nullable
MiscOnInv'Y' | 'N'

Miscellaneous Distributions on Invoice. Optional. If omitted, N will be defaulted.

MiscOnPay'Y' | 'N'

Miscellaneous Distributions on Payment. Optional. If omitted, N will be defaulted.

ABNstring nullable

[PROTECTED FIELD] Australian Business Number. Should be omitted unless the hq/company_parameters.DefaultCountry = AU. Optional. If omitted null will be defaulted.

ACNstring nullable

[PROTECTED FIELD] Australian Corporate Number. Should be omitted unless the hq/company_parameters.DefaultCountry = AU Optional. If omitted null will be defaulted.

__custom_fieldsobject

Add properties to this object for any custom fields you want to set as this record is added to Vista.

Response

Success

idstring
operationstring
statusstring