Accounts Payable entity reference

This topic describes the entity and type representations for common items that the Accounts Payable API uses. To learn about how to set up your developer account and work with the SKY API, see the Getting Started guide.

ActivityTypeSummary

Brief activity type information.

The ActivityTypeSummary entity has the following properties:

Property	Type	Description
activity_type_id	integer	Activity type identifier.
activity_code	integer	The activity type code.
description	string	The description for the activity type.
gst_rebate_factor	number	The gst rebate factor for the activity type.
pst_rebate_factor	number	The pst rebate factor for the activity type.
eligible_for_rebate	boolean	If eligible for rebate.
gst_receivable_account_number	string	The gst receivable account number for the activity type.
receivable_account_mask	string	The masked receivable account for the activity type.
pst_receivable_account_number	string	The pst receivable account number for the activity type.

ActivityTypeSummaryApiCollection

Collection Response

The ActivityTypeSummaryApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of activitytypesummary	Brief activity type information.

AddressContactMethod

Address information

The AddressContactMethod entity has the following properties:

Property	Required	Type	Description
contact_method_id		integer	The address contact method identifier.
contact_type	Property is required	string	The type of contact (email, phone, etc).
contact_info	Property is required	string	The contact information (email address, phone number, etc) for this method.

AddressContactMethodPagedResponse

Paged Response

The AddressContactMethodPagedResponse entity has the following properties:

Property	Required	Type	Description	Description
count		integer
results		array of addresscontactmethod	Address information

AttachmentSummary

Response class for an attachment.

The AttachmentSummary entity has the following properties:

Property	Type	Description
id	integer	The attachment identifier.
name	string	The name of this attachment.
url	string	The URL of this attachment.
type	string	The attachment type. Available values are Link and Physical. Physical attachments are stored and managed in the system. Link attachments are stored and managed externally. Defaults to Link if not provided. Link Physical
media_type	string	User-defined category of this attachment. Available values are the entries in the Media Type table for the parent record. Use the value types defined in /mediaTypes
date_attached	datetime	The date the attachment was added.

AttachmentSummaryApiCollection

Collection Response

The AttachmentSummaryApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of attachmentsummary	Response class for an attachment.

BackgroundProcessResult

Background process result by process id

The BackgroundProcessResult entity has the following properties:

Property	Required	Type	Description	Description
record_id		integer	The record identifier created by the background process.

BackgroundProcessStatus

The registered background process status.

The BackgroundProcessStatus entity has the following properties:

Property	Type	Description
status	integer	The background process status as an integer value of the enum TaskStatus. For status details, refer to https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.taskstatus?view=netframework-4.8. System.Threading.Tasks.TaskStatus
status_message	string	The background process status message.
process_id	integer	The background process identifier.

BasicErrorMessage

The BasicErrorMessage entity has the following properties:

Property	Required	Type	Description	Description
Error		string

BoxNumber

Contract for 1099 box number information.

The BoxNumber entity has the following properties:

Property	Type	Description
number	string	The box number for the box number.
state	string	The state for the box number.
percent	number	The percent for the box number.
amount	number	The amount for the box number.

BoxNumberPagedResponse

Paged Response

The BoxNumberPagedResponse entity has the following properties:

Property	Required	Type	Description	Description
count		integer
results		array of boxnumber	Contract for 1099 box number information.

Buyer

Contract for buyer.

The Buyer entity has the following properties:

Property	Type	Description
id	integer	The identifier for this buyer.
description	string	The description of the buyer.
value	string	The value of the buyer.
inactive	boolean	Whether or not the buyer is active.

BuyerApiCollection

Collection Response

The BuyerApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of buyer	Contract for buyer.

CreateAddressContactMethod

The CreateAddressContactMethod entity has the following properties:

Property	Required	Type	Description
vendor_id		integer	Vendor identifier.
address_id		integer	Address identifier.
contact_type		string	The type of contact (email, phone, etc).
contact_info	Property is required	string	The contact information (email address, phone number, etc) for this method.

CreateAttachment

Request for creating an attachment.

The CreateAttachment entity has the following properties:

Property	Required	Type	Description
parent_id	Property is required	integer	The identifier of the parent item for this attachment.
name	Property is required	string	The name of this attachment.
url		string	The URL of this attachment.
type	Property is required	string	The attachment type. Available values are Link and Physical. Physical attachments are stored and managed in the system. Link attachments are stored and managed externally. Defaults to Link if not provided. Link Physical
media_type	Property is required	string	User-defined category of this attachment. Available values are the entries in the Media Type table for the parent record. Use the value types defined in /mediaTypes
file		binary	The uploaded file for this attachment.

CreateCreditMemo

Contract for creating credit memo.

The CreateCreditMemo entity has the following properties:

Property	Required	Type	Description
vendor_id	Property is required	integer	The identifier for the vendor to make the credit memo.
date	Property is required	datetime	The date for the credit memo.
amount	Property is required	number	The amount of this credit memo.
credit_memo_number		string	The credit memo number.
description		string	The description for this credit memo.
post_status		string	The post status of this credit memo. DoNotPost NotYetPosted Posted
post_date	Property is required	datetime	The post date for this credit memo.
invoice_applications		array of createcreditmemoinvoiceapplication	Create invoice application
distributions	Property is required	array of createdistribution	Contract for creating distribution.
custom_fields		array of createcustomfield	The create contract for custom fields.
form_1099_box_numbers		array of invoiceboxnumber	The contract for invoice box number.

CreateCreditMemoInvoiceApplication

Create invoice application

The CreateCreditMemoInvoiceApplication entity has the following properties:

Property	Required	Type	Description
credit_memo_amount_to_apply	Property is required	number	The credit amount to apply to the invoice.
invoice_id	Property is required	integer	The invoice to apply to.
post_date	Property is required	datetime	The post date of the application.

CreateCustomField

The create contract for custom fields.

The CreateCustomField entity has the following properties:

Property	Required	Type	Description
field_name	Property is required	string	The name of the custom field.
value	Property is required	string	The value for this custom field.
comments		string	The description for this custom field.
date		datetime	The date on this custom field.

CreateDistribution

Contract for creating distribution.

The CreateDistribution entity has the following properties:

Property	Required	Type	Description
distribution_id		integer	The distribution identifier.
distribution_splits	Property is required	array of distributionsplit	Journal Entry Distribution.
amount		number	The distribution amount.
description		string	The description for this distribution.
account_number		string	The account number for this distribution.
type_code		string	The journal entry transaction type (debit or credit). Credit Debit
custom_fields		array of createcustomfield	The create contract for custom fields.

CreateGSTSalesTaxDetail

Contract for creating gst sales tax detail (Canada and Australia only).

The CreateGSTSalesTaxDetail entity has the following properties:

Property	Required	Type	Description	Description
tax_entity		string	The sales tax entity code.
amount		number	The sales tax entity amount.

CreateInvoice

Contract for creating invoice.

The CreateInvoice entity has the following properties:

Property	Required	Type	Description
vendor_id	Property is required	integer	The id of the vendor for this invoice.
purchase_order_number		string	The purchase order number for this invoice.
amount	Property is required	number	The amount of this invoice.
description		string	The description for this invoice.
invoice_number		string	The invoice number.
approval_status		string	The approval status of this invoice. Approved Deleted Paid PartiallyPaid Pending
due_date	Property is required	datetime	The due date for this invoice.
payment_details	Property is required	createinvoicepaymentdetails
invoice_date	Property is required	datetime	The date for the invoice.
post_status		string	The post status of this invoice. DoNotPost NotYetPosted Posted
post_date	Property is required	datetime	The post date for this invoice.
distribute_discounts		boolean	If to distribute discounts to invoice expense accounts.
distributions	Property is required	array of createdistribution	Contract for creating distribution.
custom_fields		array of createcustomfield	The create contract for custom fields.
form_1099_box_numbers		array of invoiceboxnumber	The contract for invoice box number.
include_tax		boolean	If or not to include tax on this invoice (CANADA and AUSTRALIA only).
amount_before_tax		number	The amount before tax of this invoice (CANADA and AUSTRALIA only).
gst_tax_type_id		integer	The gst tax type id for this invoice (CANADA and AUSTRALIA only).
psb_activity_code_id		integer	The Psb activity code id for this invoice (CANADA only).
tax_amount		number	The tax amount of this invoice (CANADA and AUSTRALIA only).
gst_rebate_amount		number	The gst rebate amount of this invoice (CANADA only).
pst_rebate_amount		number	The pst rebate amount of this invoice (CANADA only).
gst_rebate_distribution		array of createrebatedistribution	Contract for creating rebate distribution (Canada and Australia only).
pst_rebate_distribution		array of createrebatedistribution	Contract for creating rebate distribution (Canada and Australia only).
tax_distribution		array of createrebatedistribution	Contract for creating rebate distribution (Canada and Australia only).
gst_sales_tax_detail_list		array of creategstsalestaxdetail	Contract for creating gst sales tax detail (Canada and Australia only).

CreateInvoiceAdjustment

The contract for invoice adjustments.

The CreateInvoiceAdjustment entity has the following properties:

Property	Required	Type	Description
post_date	Property is required	datetime	The post date for the invoice adjustment.
adjustment_date	Property is required	datetime	The adjustment date for the invoice adjustment.
reason	Property is required	string	The reason for the invoice adjustment.
notes		string	The notes for the invoice adjustment.
adjustment_amount	Property is required	number	The adjustment amount for the invoice adjustment.
adjustment_distributions	Property is required	array of createdistribution	Contract for creating distribution.

CreateInvoicePaymentDetails

The CreateInvoicePaymentDetails entity has the following properties:

Property	Type	Description
remit_to	remittoaddressid	The remit to address
payment_method	string	The payment method. BankDraft Check CreditCard EFT
paid_from	string	The bank from which this was paid.
credit_card_account_id	integer	The identifier of the credit card account to pay from. Required for CreditCard payment details.
credit_card_id	integer	The identifier of the credit card to pay from. Required for CreditCard payment details.
hold_payment	boolean	If or not to hold payment on this invoice.
create_separate_payment	boolean	If or not to create a separate payment for this invoice.

CreateLineItem

Line item summary

The CreateLineItem entity has the following properties:

Property	Required	Type	Description
type	Property is required	string	The type of the line item. The accounts Payable API currently only supports creating Regular line items. Comment Miscellaneous Regular
product_id	Property is required	integer	The product identifier of the line item.
vendor_part_number		string	The vendor part number of the line item.
description		string	The description of the line item.
quantity_ordered	Property is required	number	The quantity ordered of the line item.
unit_of_measure		string	The unit of measure of the line item.
unit_cost	Property is required	number	The unit of cost of the line item.
extended_cost	Property is required	number	The extended cost of the line item.
post_status	Property is required	string	The post status of the line item. DoNotPost NotYetPosted Posted
post_date		datetime	The post date of the line item. Is required for line items with the status NotYetPosted
comments		string	The comments of the line item.
notes		string	The notes of the line item.
deliver_to		string	The staff member to deliver to for the line item.
requested_by		string	The staff member that requested the line item.
department		string	The department of the line item.
distributions	Property is required	array of createdistribution	Contract for creating distribution.
interfund_set		string	The interfund set for this line item's distributions.

CreateNoteAction

Request for creating a note/action.

The CreateNoteAction entity has the following properties:

Property	Type	Description
note_type	string	The type of this object - note, or action. Action Note
date	datetime	Gets or sets the date.
content	string	Gets or sets the content.
description	string	Gets or sets the description.
type	string	Gets or sets the action or note type.
is_complete	boolean	Gets or sets the bool value.
assign_to	string	Gets or sets the assign to.
completed_date	datetime	Gets or sets the date.

CreatePurchaseOrder

Contract for creating a purchase order.

The CreatePurchaseOrder entity has the following properties:

Property	Required	Type	Description
order_number		long	The order number of the purchase order. Is required unless business rules state otherwise.
order_date		datetime	The date of the purchase order. Is required for Blanket and Regular purchase orders.
type	Property is required	string	The type of the purchase order. Blanket Regular Template
order_status		string	The status of the purchase order. Defaults to UnprintedPurchaseOrder CanceledOrder ClosedOrder DeletedOrder OpenPurchaseOrder ReprintOrder UnprintedCancellationNotice UnprintedPurchaseOrder UprintedChangeOrder
vendor_id	Property is required	integer	The vendor id of the purchase order.
terms	Property is required	string	The term of the purchase order.
ship_to_address_id		integer	The identifier of the ship to address of the purchase order.
department		string	The department of the purchase order.
buyer		string	The buyer of the purchase order.
ship_via	Property is required	string	The shipping method of the purchase order.
fob		string	The freight on board of the purchase order.
ordered_by		string	The orderer of the purchase order.
order_from_contact_id	Property is required	integer	The vendor contact identifier for the orderer of the purchase order.
attention		string	The staff member for attention of the purchase order.
comments		string	The comments of the purchase order.
expiration_date		datetime	The expiration date of the purchase order. Is required for Blanket purchase orders.
custom_fields		array of customfield	Custom field definition.
line_items		array of createlineitem	Line item summary

CreateRebateDistribution

Contract for creating rebate distribution (Canada and Australia only).

The CreateRebateDistribution entity has the following properties:

Property	Required	Type	Description
tax_entity_id		string	The tax entity id.
distribution_id		integer	The distribution identifier.
distribution_splits	Property is required	array of distributionsplit	Journal Entry Distribution.
amount		number	The distribution amount.
description		string	The description for this distribution.
account_number		string	The account number for this distribution.
type_code		string	The journal entry transaction type (debit or credit). Credit Debit
custom_fields		array of createcustomfield	The create contract for custom fields.

CreateVendor

Contract for creating a vendor.

The CreateVendor entity has the following properties:

Property	Required	Type	Description
vendor_name	Property is required	string	Vendor name.
vendor_type		string	The type of vendor. Individual Organization
customer_number		string	The customer number.
tax_id_number		string	The tax id number.
vendor_status		string	Status of vendor. Active, pending, or on hold. Active Inactive OnHold
issue_1099s		boolean	If to issue 1099s to this vendor.
address		array of vendoraddress	Address information
vendor_payment_default		vendorpaymentdefault	Vendor Information.
custom_fields		array of createcustomfield	The create contract for custom fields.
ui_defined_id		string	The user defined identifier for this vendor.
gst_tax_type_id		integer	The tax type identifier for this vendor (CANADA and AUSTRALIA only).
psb_activity_code_id		integer	The Psb activity code identifier for this vendor (CANADA only).
gst_branch		string	The GST branch identifier for this vendor (AUSTRALIA only).

CreateVendorAddress

The CreateVendorAddress entity has the following properties:

Property	Type	Description
description	string	The description for this address.
country	string	The country for the address.
city	string	The city for the address.
county	string	The county for this address.
state	string	The state or province (or suburb in NZ) for the address.
address_line	string	The street information / address line for this address.
postal	string	Refers to the Postal Code or ZIP of the address.
is_primary	boolean	If this address is the primary address.
is_invoices	boolean	If invoices are sent to this address.
is_pos	boolean	If POs are sent to this address.
issue_1099s	boolean	If 1099s are sent to this address.
title	string	The title for the primary contact.
first_name	string	The first name of the primary contact.
middle_name	string	The middle initial or name of the primary contact.
last_name	string	The last name of the primary contact.
suffix	string	The suffix of the primary contact.
position	string	The position of the primary contact.
address_contact_methods	array of addresscontactmethod	Address information

CreditMemoDetail

Class for credit memo summary contract

The CreditMemoDetail entity has the following properties:

Property	Required	Type	Description
credit_memo_id		integer	The credit memo identifier.
vendor_id		integer	The id of the vendor for this credit memo.
vendor_name		string	The name of the vendor for this credit memo.
date		datetime	The date for the credit memo.
reversal_date		datetime	The reversal date for the credit memo.
amount	Property is required	number	The amount of this credit memo.
credit_applied		number	The credit amount applied from this credit memo.
credit_remaining		number	The credit amount remaining from this credit memo.
credit_memo_number		string	The credit memo number.
description		string	The description for this credit memo.
status		string	The status of this invoice. Applied Deleted PartiallyApplied Unapplied
post_status		string	The post status of this credit memo. DoNotPost NotYetPosted Posted
post_date		datetime	The post date for this credit memo.
distributions		array of distribution	Distribution.
custom_fields		array of customfield	Custom field definition.
invoice_applications		array of creditmemoinvoiceapplicationdetail	The invoice applications for this credit memo.
form_1099_box_numbers		array of invoiceboxnumber	The contract for invoice box number.
date_added		datetime	The created date of the credit memo.
date_modified		datetime	The modified date of the credit memo.
added_by		string	The creator of the credit memo.
modified_by		string	The modifier of the credit memo.

CreditMemoInvoiceApplicationDetail

The CreditMemoInvoiceApplicationDetail entity has the following properties:

Property	Type	Description
invoice_id	integer	The invoice identifier for this application.
invoice_number	string	The number of this invoice.
invoice_amount	number	The total amount for this invoice.
invoice_balance	number	The remaining balance of this invoice.
credit_memo_amount_applied	number	The credit memo amount applied to this invoice.
post_date	datetime	The post date of this invoice application.

CreditMemoInvoiceApplicationSummary

The CreditMemoInvoiceApplicationSummary entity has the following properties:

Property	Type	Description
invoice_number	string	The number of this invoice.
invoice_date	datetime	The date of this invoice.
credit_memo_amount_applied	number	The credit memo amount applied to this invoice.
invoice_id	integer	The invoice identifier for this application.

CreditMemoSummary

Class for credit memo summary contract

The CreditMemoSummary entity has the following properties:

Property	Type	Description
credit_memo_id	integer	The identifier of the credit memo.
vendor_id	integer	The vendor id associated with the credit memo.
vendor_name	string	The name of the vendor for this credit memo.
date	datetime	The date of the credit memo.
description	string	The description of the credit memo.
status	string	The status of the credit memo. Applied Deleted PartiallyApplied Unapplied
amount	number	The amount of the credit memo.
balance	number	The remaining balance of the credit memo.
number	string	The user defined number of the credit memo.
post_status	string	The post status of the credit memo. DoNotPost NotYetPosted Posted
post_date	datetime	The post date of the credit memo.
invoice_applications	array of creditmemoinvoiceapplicationsummary	The invoices this credit memo is applied to.
date_added	datetime	The created date of the credit memo.
date_modified	datetime	The modified date of the credit memo.
added_by	string	The creator of the credit memo.
modified_by	string	The modifier of the credit memo.

CreditMemoSummaryApiCollection

Collection Response

The CreditMemoSummaryApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of creditmemosummary	Class for credit memo summary contract

CustomField

Custom field definition.

The CustomField entity has the following properties:

Property	Type	Description
field_name	string	The name of the custom field.
value	string	The value of the custom field.
comments	string	The description of the custom field.
type	string	The type of the custom field. Boolean Currency DateTime FuzzyDate Number Table Text
is_required	boolean	Required status of the custom field.
date	datetime	The date on this custom field.

CustomFieldOptions

Custom field options

The CustomFieldOptions entity has the following properties:

Property	Type	Description
custom_field_id	integer	The identifier of the custom field.
name	string	The name of the custom field.
type	string	The type of the custom field. Boolean Currency DateTime FuzzyDate Number Table Text
is_required	boolean	Required status of the custom field.
table_values	array of string	List of table values.

CustomFieldOptionsPagedResponse

Paged Response

The CustomFieldOptionsPagedResponse entity has the following properties:

Property	Required	Type	Description	Description
count		integer
results		array of customfieldoptions	Custom field options

DefaultDistribution

Distribution.

The DefaultDistribution entity has the following properties:

Property	Required	Type	Description
distribution_id		integer	The distribution identifier.
default_distribution_splits	Property is required	array of defaultdistributionsplit	Journal Entry Distribution.
account_number		string	The account number for this distribution.
percent		number	The distribution journal entry amount percentage.
type_code		string	The journal entry transaction type (debit or credit). Credit Debit
custom_fields		array of customfield	Custom field definition.

DefaultDistributionApiCollection

Collection Response

The DefaultDistributionApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of defaultdistribution	Distribution.

DefaultDistributionSplit

Journal Entry Distribution.

The DefaultDistributionSplit entity has the following properties:

Property	Required	Type	Description
distribution_split_id		integer	The distribution split identifier.
ui_project_id		string	The user-visible identifier of the project.
transaction_code_values	Property is required	array of transactioncodevalue	Transaction code value
percent		number	The distribution journal entry amount percentage.
account_class		string	The account class for this distribution split.

Department

Contract for department.

The Department entity has the following properties:

Property	Type	Description
id	integer	The identifier for this fob.
description	string	The description of the fob.
value	string	The value of the fob.
inactive	boolean	Whether or not the department is active.

DepartmentApiCollection

Collection Response

The DepartmentApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of department	Contract for department.

Distribution

Distribution.

The Distribution entity has the following properties:

Property	Required	Type	Description
distribution_id		integer	The distribution identifier.
distribution_splits	Property is required	array of distributionsplit	Journal Entry Distribution.
amount		number	The distribution amount.
description		string	The description for this distribution.
account_number		string	The account number for this distribution.
type_code		string	The journal entry transaction type (debit or credit). Credit Debit
custom_fields		array of customfield	Custom field definition.

DistributionApiCollection

Collection Response

The DistributionApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of distribution	Distribution.

DistributionSplit

Journal Entry Distribution.

The DistributionSplit entity has the following properties:

Property	Required	Type	Description
distribution_split_id		integer	The distribution split identifier.
ui_project_id		string	The user-visible identifier of the project.
transaction_code_values	Property is required	array of transactioncodevalue	Transaction code value
amount		number	The distribution journal entry amount. Only one of Amount or Percent can be specified.
percent		number	The distribution journal entry amount percentage. Only one of Amount or Percent can be specified.
account_class		string	The account class for this distribution split.

DomainErrorMessage

The DomainErrorMessage entity has the following properties:

Property	Required	Type	Description	Description
Error		string
Details		array of string
ErrorPath		string

EditCreditMemo

Contract for editing credit memo.

The EditCreditMemo entity has the following properties:

Property	Type	Description
vendor_id	integer	The id of the vendor for this credit memo.
date	datetime	The date for the credit memo.
amount	number	The amount of this credit memo.
credit_memo_number	string	The credit memo number.
description	string	The description for this credit memo.
post_status	string	The post status of this credit memo. DoNotPost NotYetPosted Posted
post_date	datetime	The post date for this credit memo.
distributions	array of distribution	Distribution.
custom_fields	array of customfield	Custom field definition.
applied_invoices	array of creditmemoinvoiceapplicationdetail	The invoices this credit memo is applied to.
form_1099_box_numbers	array of invoiceboxnumber	The contract for invoice box number.

EditInvoice

Contract for editing invoice.

The EditInvoice entity has the following properties:

Property	Type	Description
vendor_id	integer	The vendor associated with the invoice. (Deprecated)
vendor_name	string	The name of the vendor for this invoice. (Deprecated)
invoice_number	string	The number for the invoice.
invoice_date	datetime	The date of the invoice.
due_date	datetime	The due date of the invoice.
amount	number	The amount of the invoice.
description	string	The description for the invoice.
status	string	The approval status of this invoice. Approved Deleted Paid PartiallyPaid Pending
invoice_payment_detail	editinvoicepaymentdetails
post_status	string	The post status of this invoice. DoNotPost NotYetPosted Posted
post_date	datetime	The post date for this invoice.
distribute_discounts	boolean	If to distribute discounts to invoice expense accounts.
distributions	array of distribution	Distribution.
custom_fields	array of customfield	Custom field definition.

EditInvoicePaymentDetails

The EditInvoicePaymentDetails entity has the following properties:

Property	Type	Description
remit_to	remittoaddress	The remit to address
payment_method	string	The payment method. BankDraft Check CreditCard EFT
paid_from	string	The bank from which this was paid.
credit_card_account_id	integer	The identifier of the credit card account from which this was paid.
credit_card_id	integer	The identifier of the credit card from which this was paid.
hold_payment	boolean	If or not to hold payment on this invoice.
create_separate_payment	boolean	If or not to create a separate payment for this invoice.

EditVendor

Contract for editing a vendor.

The EditVendor entity has the following properties:

Property	Type	Description
vendor_name	string	Vendor name.
vendor_type	string	Type of the Vendor Individual Organization
customer_number	string	The customer number.
vendor_status	string	Status of vendor. Active, pending, or on hold. Active Inactive OnHold
issue_1099s	boolean	If to issue 1099s to this vendor.
vendor_payment_default	vendorpaymentdefault	Vendor Information.
custom_fields	array of customfield	Custom field definition.

EditVendorAddress

The contract for edit vendor address

The EditVendorAddress entity has the following properties:

Property	Type	Description
description	string	The description for this address.
country	string	The country for the address.
city	string	The city for the address.
county	string	The county for the address.
state	string	The state or province (or suburb in NZ) for the address.
postal	string	Refers to the Postal Code or ZIP of the address.
address_line	string	The street/address line for this address.
is_primary	boolean	If this address is the primary address.
is_invoices	boolean	If invoices are sent to this address.
is_pos	boolean	If purchase orders are sent to this address.
is_1099	boolean	If 1099s are sent to this address.
title	string	The title for the primary contact.
first_name	string	The first name of the primary contact.
middle_name	string	The middle initial or name of the primary contact.
last_name	string	The last name of the primary contact.
suffix	string	The suffix of the primary contact.
position	string	The position of the primary contact.
address_contact_methods	array of addresscontactmethod	Address information

FOB

Contract for freight on board.

The FOB entity has the following properties:

Property	Type	Description
id	integer	The identifier for this fob.
description	string	The description of the fob.
value	string	The value of the fob.
inactive	boolean	Whether or not the fob is active.

FOBApiCollection

Collection Response

The FOBApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of fob	Contract for freight on board.

Form1099

Response class for 1099 information.

The Form1099 entity has the following properties:

Property	Required	Type	Description	Description
amount		number	The amount distributed to 1099.
excluded_amount		number	The amount excluded from 1099.

Int32CreatedResult

The Int32CreatedResult entity has the following properties:

Property	Required	Type	Description	Description
record_id		integer

InterfundSet

Contract for interfund set.

The InterfundSet entity has the following properties:

Property	Type	Description
id	integer	The identifier for this interfund set.
description	string	The description of the interfund set.
value	string	The value of the interfund set.

InterfundSetApiCollection

Collection Response

The InterfundSetApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of interfundset	Contract for interfund set.

InvoiceAdjustment

Contract for invoice adjustment

The InvoiceAdjustment entity has the following properties:

Property	Type	Description
adjustment_distributions	distributionapicollection	Collection Response
adjustment_id	integer	The identifier for the invoice adjustment.
post_status	string	The post status for the invoice adjustment. DoNotPost NotYetPosted Posted
post_date	datetime	The post date for the invoice adjustment.
adjustment_date	datetime	The adjustment date for the invoice adjustment.
reason	string	The reason for the invoice adjustment.
notes	string	The notes for the invoice adjustment.

InvoiceAdjustmentSummary

Contract for invoice adjustment summary.

The InvoiceAdjustmentSummary entity has the following properties:

Property	Type	Description
adjustment_id	integer	The identifier for the invoice adjustment.
post_status	string	The post status for the invoice adjustment. DoNotPost NotYetPosted Posted
post_date	datetime	The post date for the invoice adjustment.
adjustment_date	datetime	The adjustment date for the invoice adjustment.
reason	string	The reason for the invoice adjustment.
notes	string	The notes for the invoice adjustment.

InvoiceAdjustmentSummaryApiCollection

Collection Response

The InvoiceAdjustmentSummaryApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of invoiceadjustmentsummary	Contract for invoice adjustment summary.

InvoiceBoxNumber

The contract for invoice box number.

The InvoiceBoxNumber entity has the following properties:

Property	Type	Description
number	string	The number for the box number.
state	string	The reporting state for the box number.
amount	number	The amount for the box number.

InvoiceDetail

Invoice Information

The InvoiceDetail entity has the following properties:

Property	Required	Type	Description
invoice_id		integer	The invoice identifier.
vendor_id	Property is required	integer	The vendor associated with the invoice.
vendor_name		string	The name of the vendor for this invoice.
invoice_number		string	The number for the invoice.
invoice_date	Property is required	datetime	The date of the invoice.
due_date	Property is required	datetime	The due date of the invoice.
amount	Property is required	number	The amount of the invoice.
balance		number	The current balance on this invoice.
total_paid		number	The total amount paid on this invoice.
description	Property is required	string	The description for the invoice.
status	Property is required	string	The approval status of this invoice. Approved Deleted Paid PartiallyPaid Pending
invoice_payment_detail		invoicepaymentdetails	Invoice Payment Information
post_status		string	The post status of this invoice. DoNotPost NotYetPosted Posted
post_date		datetime	The post date for this invoice.
distribute_discounts		boolean	If to distribute discounts to invoice expense accounts.
distributions		array of distribution	Distribution.
custom_fields		array of customfield	Custom field definition.
date_added		datetime	The created date of the invoice.
date_modified		datetime	The modified date of the invoice.
added_by		string	The creator of the invoice.
modified_by		string	The modifier of the invoice.
adjustment_summary		invoiceadjustmentsummary	Contract for invoice adjustment summary.
purchase_order_number		string	The purchase order number for the invoice.
gst_tax_type_id		integer	The tax type for the invoice (CANADA and AUSTRALIA only).
psb_activity_code_id		integer	The psb activity code for the invoice (CANADA only).
include_tax		boolean	If or not to include tax on this invoice (CANADA and AUSTRALIA only).
invoice_amount_before_tax		number	The invoice amount before tax.
tax_amount		number	The tax amount for the invoice (CANADA and AUSTRALIA only).
gst_rebate_amount		number	The gst rebate amount for the invoice (CANADA only).
pst_rebate_amount		number	The pst rebate amount for the invoice (CANADA only).
gst_rebate_distribution		array of rebatedistribution	Rebate distribution.
pst_rebate_distribution		array of rebatedistribution	Rebate distribution.
tax_distribution		array of rebatedistribution	Rebate distribution.

InvoicePaymentDetails

Invoice Payment Information

The InvoicePaymentDetails entity has the following properties:

Property	Type	Description
remit_to	remittoaddress	The remit to address
payment_method	string	The payment method. BankDraft Check CreditCard EFT
paid_from	string	The bank from which this was paid.
credit_card_account_name	string	The credit card account from which this was paid.
credit_card_account_id	integer	The identifier of the credit card account from which this was paid.
credit_card_name	string	The credit card from which this was paid.
credit_card_id	integer	The identifier of the credit card from which this was paid.
hold_payment	boolean	If or not to hold payment on this invoice.
create_separate_payment	boolean	If or not to create a separate payment for this invoice.
payments	array of invoicepaymentsummary	The payments on this invoice.

InvoicePaymentSummary

The InvoicePaymentSummary entity has the following properties:

Property	Type	Description
payment_date	datetime	The date for this payment.
transaction_number	string	The transaction number for this payment.
payment_status	string	The status of this payment. Deleted Paid Scheduled Voided
amount	number	The amount of this payment.
br_transaction_id	integer	The transaction identifier on this payment.
checks_7_id	integer	The checks identifier from Financial Edge 7.

InvoiceProcessDetails

Invoice Process Information

The InvoiceProcessDetails entity has the following properties:

Property	Required	Type	Description	Description
process_id		integer	The process identifier for the invoice process.

InvoiceSummary

The InvoiceSummary entity has the following properties:

Property	Type	Description
invoice_id	integer	The invoice identifier.
invoice_number	string	The number for the invoice.
invoice_date	datetime	The date for the invoice.
vendor_id	integer	The vendor associated with the invoice.
vendor_name	string	The name of the vendor for this invoice.
vendor_status	string	The status of the vendor for this invoice. Active Inactive OnHold
amount	number	The amount of the invoice.
description	string	The description for the invoice .
status	string	The approval status of this invoice. Approved Deleted Paid PartiallyPaid Pending
post_status	string	the post status of this invoice. DoNotPost NotYetPosted Posted
balance	number	The current balance on this invoice.
is_past_due	boolean	If the invoice is past due.
amount_due	number	The amount still due on the invoice.
age	string	The age of the invoice.
date_added	datetime	The created date of the invoice.
date_modified	datetime	The modified date of the invoice.
added_by	string	The creator of the invoice.
modified_by	string	The modifier of the invoice.
payment_method	string	The payment method of the invoice. BankDraft Check CreditCard EFT
purchase_order_number	string	The purchase order number for the invoice.
gst_tax_type	string	The tax type for the invoice (CANADA and AUSTRALIA only).

InvoiceSummaryApiCollection

Collection Response

The InvoiceSummaryApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of invoicesummary

LineItemDetail

Line item detail

The LineItemDetail entity has the following properties:

Property	Type	Description
purchase_order_id	integer	The purchase order identifier of the line item.
order_number	long	The purchase order number of the line item.
vendor_id	integer	The vendor identifier of the line item.
vendor_name	string	The vendor name of the line item.
distributions	array of distribution	Distribution.
line_item_id	integer	The identifier of the line item.
line_number	integer	The number of the line item.
type	string	The type of the line item. Comment Miscellaneous Regular
product_id	integer	The prodcut identifier of the line item.
vendor_part_number	string	The vendor part number of the line item.
description	string	The description of the line item.
product_code	string	The product code of the line item.
quantity_ordered	number	The quantity ordered of the line item.
quantity_received	number	The quantity received of the line item.
quantity_cancelled	number	The quantity cancelled of the line item.
quantity_rejected	number	The quantity rejected of the line item.
unit_of_measure	string	The unit of measure of the line item.
unit_cost	number	The unit of cost of the line item.
extended_cost	number	The extended cost of the line item.
post_status	string	The post status of the line item. DoNotPost NotYetPosted Posted
post_date	datetime	The post date of the line item.
comments	string	The comments of the line item.
status	string	The receipt status of the line item. FullyReceipted NotReceipted PartiallyReceipted
deliver_to	string	The staff member to deliver to for the line item.
department	string	The department of the line item.
date_added	datetime	The date the line item was added.
added_by	string	The creator of the line item.
date_modified	datetime	The date the line item was modified.
modified_by	string	The modifier of the line item.

LineItemSummary

Line item summary

The LineItemSummary entity has the following properties:

Property	Type	Description
line_item_id	integer	The identifier of the line item.
line_number	integer	The number of the line item.
type	string	The type of the line item. Comment Miscellaneous Regular
product_id	integer	The prodcut identifier of the line item.
vendor_part_number	string	The vendor part number of the line item.
description	string	The description of the line item.
product_code	string	The product code of the line item.
quantity_ordered	number	The quantity ordered of the line item.
quantity_received	number	The quantity received of the line item.
quantity_cancelled	number	The quantity cancelled of the line item.
quantity_rejected	number	The quantity rejected of the line item.
unit_of_measure	string	The unit of measure of the line item.
unit_cost	number	The unit of cost of the line item.
extended_cost	number	The extended cost of the line item.
post_status	string	The post status of the line item. DoNotPost NotYetPosted Posted
post_date	datetime	The post date of the line item.
comments	string	The comments of the line item.
status	string	The receipt status of the line item. FullyReceipted NotReceipted PartiallyReceipted
deliver_to	string	The staff member to deliver to for the line item.
department	string	The department of the line item.
date_added	datetime	The date the line item was added.
added_by	string	The creator of the line item.
date_modified	datetime	The date the line item was modified.
modified_by	string	The modifier of the line item.

LineItemSummaryApiCollection

Collection Response

The LineItemSummaryApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of lineitemsummary	Line item summary

MediaType

Response class for media type.

The MediaType entity has the following properties:

Property	Type	Description
type_id	integer	The identifier for this media type.
description	string	The description of the media type.
value	string	The value of the media type.

MediaTypePagedResponse

Paged Response

The MediaTypePagedResponse entity has the following properties:

Property	Required	Type	Description	Description
count		integer
results		array of mediatype	Response class for media type.

NoteAction

Response class for a note/action.

The NoteAction entity has the following properties:

Property	Type	Description
note_action_id	integer	The note or action identifier.
note_type	string	The record type (note or action). Action Note
date	datetime	The date of the note or action.
content	string	The content of the note or action.
description	string	The description of the note or action.
type	string	The type of the note or action.
is_complete	boolean	If the action has been completed.
assign_to	string	The assigned of the note or action.
completed_date	datetime	The completion date of the note or action.

NoteActionPagedResponse

Paged Response

The NoteActionPagedResponse entity has the following properties:

Property	Required	Type	Description	Description
count		integer
results		array of noteaction	Response class for a note/action.

OrgAddress

Contract for organization address.

The OrgAddress entity has the following properties:

Property	Required	Type	Description	Description
id		integer	The identifier for this organization address.
description		string	The description of the organization address.

OrgAddressApiCollection

Collection Response

The OrgAddressApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of orgaddress	Contract for organization address.

PaymentTerm

Contract for payment term.

The PaymentTerm entity has the following properties:

Property	Type	Description
id	integer	The identifier for this payment term.
description	string	The description of the payment term.
value	string	The value of the payment term.
due_days	integer	The number of due days for the payment term.
discount_percent	number	The discount percent of the payment term.
discount_days	integer	The number of discount days for the payment term.

PaymentTermPagedResponse

Paged Response

The PaymentTermPagedResponse entity has the following properties:

Property	Required	Type	Description	Description
count		integer
results		array of paymentterm	Contract for payment term.

Product

Contract for product.

The Product entity has the following properties:

Property	Type	Description
id	integer	The identifier for this product.
description	string	The description of the product.
code	string	The code of the product.

ProductApiCollection

Collection Response

The ProductApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of product	Contract for product.

PurchaseOrderDetail

Purchase order detail

The PurchaseOrderDetail entity has the following properties:

Property	Type	Description
ship_to_address	string	The ship to address of the purchase order.
department	string	The department of the purchase order.
buyer	string	The buyer of the purchase order.
ship_via	string	The shipping method of the purchase order.
fob	string	The freight on board of the purchase order.
ordered_by	string	The orderer of the purchase order.
ordered_from_contact_id	integer	The contact identifier for the orderer of the purchase order.
attention	string	The staff member for attention of the purchase order.
comments	string	The comments of the purchase order.
custom_fields	array of customfield	Custom field definition.
purchase_order_id	integer	The purchase order's identifier.
order_number	long	The order number of the purchase order.
order_date	datetime	The date of the purchase order.
type	string	The type of the purchase order. Blanket Regular Template
order_total	number	The total of the purchase order.
receipted_total	number	The receipted total of the purchase order.
order_status	string	The status of the purchase order. CanceledOrder ClosedOrder DeletedOrder OpenPurchaseOrder ReprintOrder UnprintedCancellationNotice UnprintedPurchaseOrder UprintedChangeOrder
vendor_name	string	The vendor name assocaited with the purchase order.
vendor_id	integer	The vendor id of the purchase order.
terms	string	The term of the purchase order.
date_added	datetime	The created date of the purchase order.
added_by	string	The creator of the purchase order.
date_modified	datetime	The modified date of the purchase order.
modified_by	string	The modifier of the purchase order.

PurchaseOrderSummary

The PurchaseOrderSummary entity has the following properties:

Property	Type	Description
purchase_order_id	integer	The purchase order's identifier.
order_number	long	The order number of the purchase order.
order_date	datetime	The date of the purchase order.
type	string	The type of the purchase order. Blanket Regular Template
order_total	number	The total of the purchase order.
receipted_total	number	The receipted total of the purchase order.
order_status	string	The status of the purchase order. CanceledOrder ClosedOrder DeletedOrder OpenPurchaseOrder ReprintOrder UnprintedCancellationNotice UnprintedPurchaseOrder UprintedChangeOrder
vendor_name	string	The vendor name assocaited with the purchase order.
vendor_id	integer	The vendor id of the purchase order.
terms	string	The term of the purchase order.
date_added	datetime	The created date of the purchase order.
added_by	string	The creator of the purchase order.
date_modified	datetime	The modified date of the purchase order.
modified_by	string	The modifier of the purchase order.

PurchaseOrderSummaryApiCollection

Collection Response

The PurchaseOrderSummaryApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of purchaseordersummary

RebateDistribution

Rebate distribution.

The RebateDistribution entity has the following properties:

Property	Required	Type	Description
tax_entity_id		string	The tax entity id.
distribution_id		integer	The distribution identifier.
distribution_splits	Property is required	array of distributionsplit	Journal Entry Distribution.
amount		number	The distribution amount.
description		string	The description for this distribution.
account_number		string	The account number for this distribution.
type_code		string	The journal entry transaction type (debit or credit). Credit Debit
custom_fields		array of customfield	Custom field definition.

ReceiptDetail

Receipt detail

The ReceiptDetail entity has the following properties:

Property	Type	Description
receipt_id	integer	The receipt's identifier.
receipt_number	long	The number of the receipt.
purchase_order_number	string	The purchase order number assocaited with the receipt.
purchase_order_id	integer	The purchase order id assocaited with the receipt.
receipt_date	datetime	The date of the receipt.
description	string	The description of the receipt.
received_by	string	The receiver of the receipt.
vendor_name	string	The vendor name assocaited with the receipt.
vendor_id	integer	The vendor id assocaited with the receipt.
receipt_total	number	The total of the receipt.
invoice_number	string	The invoice number assocaited with the receipt.
invoice_id	integer	The invoice id assocaited with the receipt.
date_added	datetime	The created date of the receipt.
added_by	string	The creator of the receipt.
date_modified	datetime	The modified date of the receipt.
modified_by	string	The modifier of the receipt.

ReceiptSummary

The ReceiptSummary entity has the following properties:

Property	Type	Description
receipt_id	integer	The receipt's identifier.
receipt_number	long	The number of the receipt.
purchase_order_number	string	The purchase order number assocaited with the receipt.
purchase_order_id	integer	The purchase order id assocaited with the receipt.
receipt_date	datetime	The date of the receipt.
description	string	The description of the receipt.
received_by	string	The receiver of the receipt.
vendor_name	string	The vendor name assocaited with the receipt.
vendor_id	integer	The vendor id assocaited with the receipt.
receipt_total	number	The total of the receipt.
invoice_number	string	The invoice number assocaited with the receipt.
invoice_id	integer	The invoice id assocaited with the receipt.
date_added	datetime	The created date of the receipt.
added_by	string	The creator of the receipt.
date_modified	datetime	The modified date of the receipt.
modified_by	string	The modifier of the receipt.

ReceiptSummaryApiCollection

Collection Response

The ReceiptSummaryApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of receiptsummary

RemitToAddress

The remit to address

The RemitToAddress entity has the following properties:

Property	Required	Type	Description
address_id		integer	The address identifier.
description	Property is required	string	The description for this address.
country		string	The country for the address.
city		string	The city for the address.
county		string	The county for the address.
state		string	The state or province (or suburb in NZ) for the address.
postal		string	Refers to the Postal Code or ZIP of the address.
address_line		string	The street for this address.
contact_name		string	The full name of the contact for this address.

RemitToAddressId

The remit to address

The RemitToAddressId entity has the following properties:

Property	Required	Type	Description	Description
address_id	Property is required	integer	The address identifier.

SalesTaxEntityDetail

Sales tax entity information (Only for CANADA and AUSTRALIA)

The SalesTaxEntityDetail entity has the following properties:

Property	Type	Description
id	integer	Sales tax entity identifier.
sequence	integer	Sales tax entity sequence.
tax_entity_code_id	integer	Sales tax entity code identifier.
entry_id	string	The tax id for this sales tax entity.
rate	number	The rate of this sales tax entity.
compound_tax	boolean	Whether or not the compound tax is selected.

SalesTaxItemDetail

Sales tax items information (Only for CANADA and AUSTRALIA)

The SalesTaxItemDetail entity has the following properties:

Property	Type	Description
id	integer	Sales tax item identifier.
sales_tax_item_tax_id	string	The tax id for this sales tax item.
inactive	boolean	Whether or not the sales tax item is active.
description	string	The description of the sales tax item.
comment	string	The comment for this sales tax item.
sales_tax_entities	array of salestaxentitydetail	Sales tax entity information (Only for CANADA and AUSTRALIA)

SalesTaxItemDetailApiCollection

Collection Response

The SalesTaxItemDetailApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of salestaxitemdetail	Sales tax items information (Only for CANADA and AUSTRALIA)

ShipVia

Contract for shipping method.

The ShipVia entity has the following properties:

Property	Type	Description
id	integer	The identifier for this shipping method.
description	string	The description of the shipping method.
value	string	The value of the shipping method.
inactive	boolean	Whether or not the shipping method is active.

ShipViaApiCollection

Collection Response

The ShipViaApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of shipvia	Contract for shipping method.

Staff

Contract for staff member.

The Staff entity has the following properties:

Property	Type	Description
id	integer	The identifier for this staff member.
description	string	The description of the staff member.
value	string	The value of the staff member.
inactive	boolean	Whether or not the staff is active.

StaffApiCollection

Collection Response

The StaffApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of staff	Contract for staff member.

State

Contract for state.

The State entity has the following properties:

Property	Required	Type	Description	Description
id		integer	The identifier for this state.
name		string	The name of the state.

StateApiCollection

Collection Response

The StateApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of state	Contract for state.

StringApiCollection

Collection Response

The StringApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of string

TaxEntity

Contract for tax entity.

The TaxEntity entity has the following properties:

Property	Required	Type	Description
id	Property is required	integer	Tax Entity Id.
description		string	Tax Entity Description.
value	Property is required	string	Tax Entity Code.
inactive	Property is required	boolean	Tax Entity active or not.

TaxEntityApiCollection

Collection Response

The TaxEntityApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of taxentity	Contract for tax entity.

TransactionCode

Journal entry transaction code

The TransactionCode entity has the following properties:

Property	Type	Description
transaction_code_id	integer	The transaction code identifier.
name	string	The transaction code name.
description	string	The transaction code description.
used_for_grants	boolean	If the transaction code is used for grants.

TransactionCodeValue

Transaction code value

The TransactionCodeValue entity has the following properties:

Property	Required	Type	Description
name		string	The transaction code name.
value	Property is required	string	The transaction code value.
id	Property is required	integer	The transaction code value id.
inactive		boolean	Indicate if record is inactive or not.

UnitOfMeasure

Contract for unit of measure.

The UnitOfMeasure entity has the following properties:

Property	Type	Description
id	integer	The identifier for this unit of measure.
description	string	The description of the unit of measure.
value	string	The value of the unit of measure.
inactive	boolean	Whether or not the unit of measure is active.

UnitOfMeasureApiCollection

Collection Response

The UnitOfMeasureApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of unitofmeasure	Contract for unit of measure.

Vendor1099Information

Contract for vendor 1099 information

The Vendor1099Information entity has the following properties:

Property	Required	Type	Description	Description
default_box_numbers		array of vendordefaultboxnumber	The contract for vendor default box number.

VendorAddress

Address information

The VendorAddress entity has the following properties:

Property	Required	Type	Description
address_id		integer	The address identifier.
description	Property is required	string	The description for this address.
country		string	The country for the address.
city		string	The city for the address.
county		string	The county for the address.
state		string	The state or province (or suburb in NZ) for the address.
postal		string	Refers to the Postal Code or ZIP of the address.
address_line		string	The street/address line for this address.
is_primary		boolean	If this address is the primary address.
is_invoices		boolean	If invoices are sent to this address.
is_pos		boolean	If purchase orders are sent to this address.
is_1099		boolean	If 1099s are sent to this address.
title		string	The title for the primary contact.
first_name		string	The first name of the primary contact.
middle_name		string	The middle initial or name of the primary contact.
last_name		string	The last name of the primary contact.
suffix		string	The suffix of the primary contact.
position		string	The position of the primary contact.
address_contact_methods		array of addresscontactmethod	Address information
payee_name		string	The payee name

VendorAddressPagedResponse

Paged Response

The VendorAddressPagedResponse entity has the following properties:

Property	Required	Type	Description	Description
count		integer
results		array of vendoraddress	Address information

VendorContact

Contract for vendor contact.

The VendorContact entity has the following properties:

Property	Type	Description
vendor_contact_id	integer	The identifier for this vendor contact.
address_description	string	The address description for this contact.
address_line	string	The address line for this contact.
contact_display_name	string	The contact display name for this contact.

VendorContactApiCollection

Collection Response

The VendorContactApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of vendorcontact	Contract for vendor contact.

VendorDefaultBoxNumber

The contract for vendor default box number.

The VendorDefaultBoxNumber entity has the following properties:

Property	Type	Description
number	string	The number for the box number.
state	string	The reporting state for the box number.
percent	number	The percent for the box number.

VendorDetail

Detailed vendor information.

The VendorDetail entity has the following properties:

Property	Required	Type	Description
vendor_id		integer	Vendor identifier.
vendor_name	Property is required	string	The name of the vendor.
vendor_type	Property is required	string	The type of the vendor (individual or organization). Individual Organization
balance_due		number	The balance due on this vendor.
ui_defined_id		string	The user-defined identifier for this vendor.
tax_id_number		string	The tax id number for this vendor
psb_activity_code		string	The Psb activity code for this vendor (CANADA only).
psb_activity_code_id		integer	The Psb activity code id for this vendor (CANADA only).
psb_activity_code_desc		string	The Psb activity code description for this vendor (CANADA only).
gst_tax_type		string	The tax type for this vendor (CANADA and AUSTRALIA only).
gst_tax_type_desc		string	The tax type description for this vendor (CANADA and AUSTRALIA only).
gst_branch		string	The branch for this vendor (AUSTRALIA only).
customer_number		string	The customer number.
vendor_status		string	Status of vendor. Active, pending, or on hold. Active Inactive OnHold
issue_1099s		boolean	If to issue 1099s to this vendor.
addresses		array of vendoraddress	Address information
vendor_payment_default		vendorpaymentdefault	Vendor Information.
custom_fields		array of customfield	Custom field definition.
date_added		datetime	The created date of the vendor.
date_modified		datetime	The modified date of the vendor.
added_by		string	The creator of the vendor.
modified_by		string	The modifier of the vendor.

VendorPaymentDefault

Vendor Information.

The VendorPaymentDefault entity has the following properties:

Property	Required	Type	Description
has_credit_limit		boolean	If or not this vendor has as credit limit.
credit_limit		number	The credit limit, if any.
payment_terms		string	The terms of the payment (NET).
account_name		string	The account from which to pay invoices.
payment_method	Property is required	string	The payment method. BankDraft Check CreditCard EFT
payment_option	Property is required	string	The payment option. OneForAll OnePerInvoice

VendorSummary

Brief vendor information

The VendorSummary entity has the following properties:

Property	Required	Type	Description
vendor_id		integer	Vendor identifier.
vendor_name	Property is required	string	The name of the vendor.
balance_due		number	The balance due on this vendor.
ui_defined_id		string	The user-defined identifier of this vendor.
customer_number		string	The customer number.
vendor_status		string	Status of vendor. Active, pending, or on hold. Active Inactive OnHold
issue_1099s		boolean	If to issue 1099s to this vendor.
primary_address		vendoraddress	Address information
payment_method		string	The default payment method of this vendor. BankDraft Check CreditCard EFT
payment_defaults		vendorpaymentdefault	Vendor Information.
date_added		datetime	The created date of the vendor.
date_modified		datetime	The modified date of the vendor.
added_by		string	The creator of the vendor.
modified_by		string	The modifier of the vendor.

VendorSummaryApiCollection

Collection Response

The VendorSummaryApiCollection entity has the following properties:

Property	Required	Type	Description	Description
count		integer
value		array of vendorsummary	Brief vendor information