Accounts Payable Entity Reference

Updated: August 3, 2016

This topic describes the entity and type representations for common items used by the Accounts Payable API.

For more information about working with the SKY API, see the Getting Started guide.

 

Vendor filters

The vendor filters entity has the following properties:

Property Type Description
offset integer The number of records to skip, for use with pagination.
limit integer The number of records to return. If not specified, the default is 100. The maximum allowed value is 1000.
vendor_name string The name of the vendor.
status string The status of the vendor.
ui_vendor_id string The UI defined ID for the vendor.

 

Vendor summary

The vendor summary entity has the following properties:

Property Type Description
vendor_id integer Vendor identifier.
vendor_name string The name of the vendor.
balance_due number The balance due on this vendor.
ui_defined_id string The UI defined Id of this vendor.
customer_number string The customer number.
vendor_status string The status of the vendor.
issue_1099s boolean Whether to issue 1099s to this vendor.
primary_address vendor address The primary address of the vendor.
payment_method string The default payment of this vendor.

 

Vendor address

The vendor address entity has the following properties:

Property Type Description
address_id integer The address identifier.
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 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 POs 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 address contact methods The list of contact methods for this address.

 

Address contact method

The address contact method entity has the following properties:

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

 

Vendor payment default

The vendor payment default entity has the following properties:

Property Type Description
has_credit_limit boolean Whether 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 D).
account_name string The account from which to pay invoices.
payment_method string The payment method for this invoice.
payment_option string The payment option for this invoice.

 

Vendor detail

The vendor detail entity has the following properties:

Property Type Description
vendor_id integer Vendor identifier.
vendor_name string The name of the vendor.
balance_due number The balance due on this vendor.
ui_defined_id string The UI defined ID for this vendor.
customer_number string The customer number.
vendor_status string The status of the vendor.
issue_1099s boolean Whether to issue 1099s to this vendor.
addresses array of vendor addresses The address(es) of the vendor.
vendor_payment_default vendor payment default The default payment of this vendor.

 

Vendor note action

The vendor note action entity has the following properties:

Property Type Description
note_action_id integer The note/action identifier.
note_type string The type - note or action.
date string The date for this note/action.
content string The content of this note/action.
description string The description for this note/action.
type string The type of the note/action.
is_complete boolean Whether this note/action is complete.
assign_to string To whom this note/action is assigned.
completed_date string The date on which this note/action was completed.

 

Invoice filters

The invoice filters entity has the following properties:

Property Type Description
offset integer The number of records to skip.
limit integer The number of records to return. If not specified, the default is 100. The maxiumum allowed value is 1000.
to_date date-time Filter for invoices before a certain date.
from_date date-time Filter for invoices after a certain date.
invoice_status string Filter by the status of the invoice.
vendor_name string Filter by vendor name.

 

Invoice summary

The invoice summary entity has the following properties:

Property Type Description
invoice_id integer The invoice identifier.
invoice_number string The number for the invoice.
invoice_date date-time The date for this invoice.
vendor_id integer The vendor identifier associated with this invoice.
vendor_name string The name of the vendor associated with this invoice.
vendor_status string The status of the vendor.
amount number The amount for this invoice.
description string The description of this invoice.
status string The status of this invoice.
invoice_post_status string The post status of this invoice.
balance number The balance on this invoice.
is_past_due boolean Whether this invoice is past due.
amount_due number The amount due on this invoice.
remit_to string The account number to which to remit for this invoice.
payment_method string The method to which to pay this invoice.
create_separate_payment boolean Whether to create a separate payment for invoice.
age string The age of this invoice.

 

Invoice detail

The invoice detail entity has the following properties:

Property Type Description
invoice_id integer The invoice identifier.
vendor_id integer The vendor identifier associated with this invoice.
vendor_name string The name of the vendor associated with this invoice.
invoice_number string The number for the invoice.
invoice_date date-time The date for this invoice.
due_date date-time The due date for this invoice.
amount number The amount for this invoice.
balance number The balance on this invoice.
total_paid number The total amount paid on this invoice.
description string The description of this invoice.
approval_status string The approval status of this invoice.
invoice_payment_details invoice payment details The payment details for this invoice.
post_status string The post status of this invoice.
post_date date-time The post date for this invoice.
distribute_discounts boolean Whether to distribute discounts on this invoice.
distributions array of distributions The distributions on this invoice.

 

Invoice payment details

The invoice payment details entity has the following properties:

Property Type Description
remit_to remit to address The address to which to remit for this invoice.
payment_method string The method with which the invoice will be paid.
paid_from string The bank from which payments are made.
hold_payment boolean Whether to hold payment on this invoice.
create_separate_payment boolean Whether to create a separate payment for this invoice.
payments array of invoice payment summaries The payments on this invoice.

 

Remit to address

The remit to address entity has the following properties:

Property Type Description
address_id integer The address identifier.
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 for this address.
contact_name string The full name of the contact for this address.

 

Invoice payment summary

The invoice payment summary entity has the following properties:

Property Type Description
payment_date date-time The date of this payment.
transaction_number string The transaction number for this payment.
payment_status string The status for this payment.
amount number The amount of this payment.
br_transaction_id integer The bank register transaction identifier for this payment.
checks_7_id integer The Checks identifier for this payment (FE 7).

 

Distribution

The distribution entity has the following properties:

Property Type Description
distribution_id integer The identifier for this distribution.
distribution_split array of distribution splits The splits on this 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).

 

Distribution split

The distribution split entity has the following properties:

Property Type Description
distribution_split_id integer The identifier for this distribution split.
ui_project_id string The project id for this split.
transaction_code_values array of transaction code values The transaction codes and values for this split.
amount number The amount for this distribution split.
percent number The amount percentage for this distribution split.

 

Transaction code value

The transaction code value entity has the following properties:

Property Type Description
name string The name for this transaction code.
value string The value for this transaction code.