Blackbaud FENXT Payable (Preview)

Reference

Blackbaud Financial Edge NXT is a comprehensive cloud-based accounting software solution built specifically for nonprofits. Use the Payables connector to manage invoices, vendors, purchase orders and related entities found within The Financial Edge NXT.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	Blackbaud Support
URL	https://www.blackbaud.com/support
Email	skyapi@blackbaud.com

Connector Metadata
Publisher	Blackbaud, Inc.
Website	https://www.blackbaud.com/products/blackbaud-financial-edge-nxt
Privacy policy	https://www.blackbaud.com/privacy-shield
Categories	Sales and CRM;Productivity

Financial Edge NXT is a comprehensive cloud-based accounting software solution built specifically for nonprofits.

This connector is built on top of Blackbaud's SKY API, and provides operations to help manage invoices, vendors, purchase orders and related entities found within The Financial Edge NXT.

For more information, please view the documentation.

Prerequisites

To use this connector, you must have a Blackbaud ID account with access to one or more Blackbaud environments.

In addition, your organization's administrator must also perform an admin-level action within the system to enable this connector to access your Blackbaud environment. More information about these prerequisites can be found in the initial setup documentation.

How to get credentials?

Your organization's administrator will send you an invitation to the organization's Financial Edge NXT environment and configure your user account permissions within the environment. No additional credentials are required to use this connector.

Known issues and limitations

The connector will operate in the context of your user account, and will therefore be subject to your user permissions within the environment.

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Create a purchase order	Creates a new purchase order.
Create a purchase order line item	Creates a new purchase order line item.
Create a vendor	Creates a new vendor.
Create a vendor action	Creates a new vendor action.
Create a vendor address	Creates a new vendor address.
Create a vendor address contact method	Creates a new contact method for a vendor address.
Create a vendor attachment	Creates a new vendor attachment.
Create a vendor note	Creates a new vendor note.
Create an invoice	Creates a new invoice using the default distributions from the specified vendor.
Create an invoice (single distribution)	Creates a new invoice with a single distribution.
Create an invoice attachment	Creates a new invoice attachment.
Delete a credit memo	Deletes a credit memo.
Delete a vendor address	Deletes a vendor address.
Delete a vendor attachment	Deletes a vendor attachment.
Delete an invoice adjustment	Deletes an invoice adjustment.
Get a purchase order	Returns information about a purchase order.
Get a purchase order line item	Returns information about a purchase order line item.
Get a receipt	Returns information about a receipt.
Get a vendor	Returns information about a vendor.
Get an invoice	Returns information about an invoice.
Get an invoice adjustment	Returns information about an invoice adjustment.
Get invoice 1099 info	Returns the 1099 information for an invoice.
Get vendor 1099 information	Get the 1099 information for a vendor.
List invoice 1099 box numbers	Lists the 1099 box numbers for an invoice.
List invoice adjustments	Lists the adjustments for an invoice.
List invoices	Lists the available invoices.
List purchase order line items	Lists the line items for a purchase order.
List purchase orders	Lists the available purchase orders.
List receipts	Lists the available receipts.
List vendor address contact methods	Lists the contact methods for a vendor address.
List vendor addresses	Lists the addresses for a vendor.
List vendor attachments	Lists the attachments for a vendor.
List vendor contacts	Lists the contacts for a vendor.
List vendor default distributions	Lists the default distributions for a vendor.
List vendor notes and actions	Lists the notes and actions for a vendor.
List vendors	Lists the available vendors.
Update a vendor	Updates a vendor.
Update a vendor address	Updates a vendor address.
Update an invoice	Updates an invoice.

Create a purchase order

Operation ID:: CreatePurchaseOrder

Creates a new purchase order.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.
Type	type	True	string	The purchase order type.
Order number	order_number	True	integer	The purchase order number.
Order date	order_date	True	date	The order date (ex: '2005-09-18').
Status	order_status	True	string	The status of the purchase order.
Order from	order_from_contact_id	True	integer	The vendor contact identifier for the orderer of the purchase order.
Ship via	ship_via	True	string	The shipping method of the purchase order.
FOB	fob		string	The freight on board of the purchase order.
Terms	terms	True	string	The term of the purchase order.
Buyer	buyer		string	The buyer of the purchase order.
Department	department		string	The department of the purchase order.
Confirm to	ordered_by		string	The orderer of the purchase order.
Ship to	ship_to_address_id		integer	The identifier of the ship to address of the purchase order.
Expires	expiration_date		date-time	The expiration date of the purchase order (required for Blanket purchase orders).
Attention	attention		string	The staff member for attention of the purchase order.
Comments	comments		string	The purchase order comments.

Returns

Created purchase order

Body: APApi.CreatedPurchaseOrder

Create a purchase order line item

Operation ID:: CreatePurchaseOrderLineItem

Creates a new purchase order line item.

Parameters

Name	Key	Required	Type	Description
Purchase order ID	purchase_order_id	True	integer	The system record ID of the purchase order.
Type	type	True	string	The type of the line item. Currently, only Regular line items is supported.
Description	description		string	The description of the line item.
Unit of measure	unit_of_measure		string	The unit of measure.
Quantity	quantity_ordered	True	decimal	The quantity ordered.
Unit cost	unit_cost	True	decimal	The line item unit cost.
Extended cost	extended_cost	True	decimal	The line item extended cost.
Vendor part number	vendor_part_number		string	The vendor part number of the line item.
Product ID	product_id	True	integer	The product identifier for the line item.
Department	department		string	The department for the line item.
Requested by	requested_by		string	The staff member that requested the line item.
Deliver to	deliver_to		string	The staff member to deliver to for the line item.
Post status	post_status	True	string	The post status for the line item.
Post date	post_date		date	The line item post date (ex: '2005-09-18').
Internal notes	notes		string	Internal notes of the line item.
External notes	comments		string	External notes for the line item.

Create a vendor

Operation ID:: CreateVendor

Creates a new vendor.

Parameters

Name	Key	Required	Type	Description
Name	vendor_name	True	string	The vendor name. Character limit: 60.
Type	vendor_type		string	The type of vendor.
Vendor ID	ui_defined_id		string	The user-defined identifier for the vendor.
Tax ID number	tax_id_number		string	The vendor tax ID number.
Customer number	customer_number		string	The vendor customer number.
Status	vendor_status		string	The vendor status.
Issue 1099 statement?	issue_1099s		boolean	Issue a 1099 statement for the vendor?
Address description	description	True	string	The address description.
Address country	country		string	The country of the address.
Address lines	address_line		string	The street/address lines for the address. Character limit: 150.
Address city	city		string	The city of the address.
Address state	state		string	The state or province (or suburb in NZ) for the address.
Address postal code	postal		string	The postal code or ZIP of the address. Character limit: 12.
Address county	county		string	The county of the address.
Address is primary?	is_primary		boolean	Is this the vendor's primary address?
Send invoices?	is_invoices		boolean	Send invoices to this address?
Send POs?	is_pos		boolean	Send purchase orders to this address?
Send 1099s?	is_1099		boolean	Send 1099s to this address?
Contact title	title		string	The title of the primary contact.
Contact first name	first_name		string	The first name of the primary contact.
Contact middle name	middle_name		string	The middle initial or name of the primary contact.
Contact last name	last_name		string	The last name of the primary contact.
Contact suffix	suffix		string	The suffix of the primary contact.
Contact position	position		string	The position of the primary contact.
Credit limit?	has_credit_limit		boolean	Does the payment default have a credit limit?
Credit limit amount	credit_limit		decimal	The payment default credit limit.
Payment terms	payment_terms		string	The terms of the payment (NET).
Payment account	account_name		string	The account from which to pay invoices.
Payment method	payment_method		string	The payment method.
Payment option	payment_option		string	The payment option.
GST branch	gst_branch		string	The GST branch identifier for this vendor (only applicable for AU versions).
GST tax type ID	gst_tax_type_id		integer	The tax type identifier for the vendor (only applicable for CA and AU versions).
PSB activity code ID	psb_activity_code_id		integer	The PSB activity code identifier for the vendor (only applicable for CA versions).

Returns

Created vendor

Body: APApi.CreatedVendor

Create a vendor action

Operation ID:: CreateVendorAction

Creates a new vendor action.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.
Type	type	True	string	The action type.
Date	date	True	date	The action date (ex: '2005-09-18').
Description	description		string	The action description. Character limit: 255.
Assigned to	assign_to	True	string	The user to whom the action will be assigned.
Is complete?	is_complete		boolean	Is the action complete?
Completed on	completed_date		date	The action completed date (ex: '2005-09-18').

Returns

Created vendor action

Body: APApi.CreatedVendorAction

Create a vendor address

Operation ID:: CreateVendorAddress

Creates a new vendor address.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.
Description	description	True	string	The address description.
Country	country		string	The country of the address.
Address lines	address_line		string	The street/address lines for the address. Character limit: 150.
City	city		string	The city of the address.
State	state		string	The state or province (or suburb in NZ) for the address.
Postal code	postal		string	The postal code or ZIP of the address. Character limit: 12.
County	county		string	The county of the address.
Is primary?	is_primary		boolean	Is this the vendor's primary address?
Send invoices?	is_invoices		boolean	Send invoices to this address?
Send POs?	is_pos		boolean	Send purchase orders to this address?
Send 1099s?	issue_1099s		boolean	Send 1099s to this address?
Payee name	payee_name		string	The payee name.
Contact title	title		string	The title of the primary contact.
Contact first name	first_name		string	The first name of the primary contact.
Contact middle name	middle_name		string	The middle initial or name of the primary contact.
Contact last name	last_name		string	The last name of the primary contact.
Contact suffix	suffix		string	The suffix of the primary contact.
Contact position	position		string	The position of the primary contact.

Returns

Created vendor address

Body: APApi.CreatedVendorAddress

Create a vendor address contact method

Operation ID:: CreateVendorAddressContactMethod

Creates a new contact method for a vendor address.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.
Address ID	address_id	True	integer	The system record ID of the vendor address.
Contact type	contact_type		string	The contact method type.
Contact info	contact_info	True	string	The contact information (email address, phone number, etc.) for this method.

Returns

Created vendor address contact method

Body: APApi.CreatedVendorAddressContactMethod

Create a vendor attachment

Operation ID:: CreateVendorAttachment

Creates a new vendor attachment.

Parameters

Name	Key	Required	Type	Description
Vendor ID	parent_id	True	integer	The system record ID of the vendor.
Type	type	True	string	The attachment type.
Name	name	True	string	The name of the attachment. Character limit: 150.
Attachment type	media_type	True	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
URL	url		string	The URL for the attachment. This is required for link attachments and ignored for physical attachments.
File contents	file		binary	The binary contents of the file attachment. This is required for physical attachments and ignored for link attachments.
File name	file_name		string	The file name for the attachment. This is required for physical attachments and ignored for link attachments.

Returns

Created vendor attachment

Body: APApi.CreatedVendorAttachment

Create a vendor note

Operation ID:: CreateVendorNote

Creates a new vendor note.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.
Type	type	True	string	The note type.
Date	date	True	date	The note date (ex: '2005-09-18').
Description	description		string	The note description. Character limit: 255.
Note	content		string	The note text.

Returns

Created vendor note

Body: APApi.CreatedVendorNote

Create an invoice

Operation ID:: CreateInvoice

Creates a new invoice using the default distributions from the specified vendor.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.
Invoice number	invoice_number	True	string	The invoice number.
Invoice date	invoice_date	True	date	The invoice date (ex: '2005-09-18').
Due date	due_date	True	date	The invoice due date (ex: '2005-09-18').
Post status	post_status	True	string	The post status for the invoice.
Post date	post_date	True	date	The invoice post date (ex: '2005-09-18').
Amount	amount	True	decimal	The invoice amount.
Description	description	True	string	The invoice description.
Approval status	approval_status	True	string	The approval status for the invoice.
Credit account	credit_account_number	True	string	The credit account number to use when generating distributions.
Distribute discounts?	distribute_discounts		boolean	Distribute discounts to invoice expense accounts?
Payment method	payment_method	True	string	The invoice payment method.
Remit to	address_id	True	integer	The remit to address for the invoice.
Paid from	paid_from		string	The bank from which the invoice is paid.
Card account ID	credit_card_account_id		integer	The system record ID of the credit card account from which the invoice is paid.
Card ID	credit_card_id		integer	The system record ID of the credit card from which the invoice is paid.
Hold payment?	hold_payment		boolean	Hold payment on this invoice?
Separate payment?	create_separate_payment		boolean	Always create a separate payment for this invoice?
box number	number	True	string	The box number.
state	state		string	The state for the box number.
amount	amount	True	decimal	The box number amount.

Returns

Created invoice

Body: APApi.CreatedInvoice

Create an invoice (single distribution)

Operation ID:: CreateSingleDistributionInvoice

Creates a new invoice with a single distribution.

Parameters

Name	Key	Required	Type	Description
body	body	True	dynamic	The invoice to create.

Returns

Created invoice

Body: APApi.CreatedInvoice

Create an invoice attachment

Operation ID:: CreateInvoiceAttachment

Creates a new invoice attachment.

Parameters

Name	Key	Required	Type	Description
Invoice ID	parent_id	True	integer	The system record ID of the invoice.
Type	type	True	string	The attachment type.
Name	name	True	string	The name of the attachment. Character limit: 150.
Attachment type	media_type	True	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
URL	url		string	The URL for the attachment. This is required for link attachments and ignored for physical attachments.
File contents	file		binary	The binary contents of the file attachment. This is required for physical attachments and ignored for link attachments.
File name	file_name		string	The file name for the attachment. This is required for physical attachments and ignored for link attachments.

Returns

Created invoice attachment

Body: APApi.CreatedInvoiceAttachment

Delete a credit memo

Operation ID:: DeleteCreditMemo

Deletes a credit memo.

Parameters

Name	Key	Required	Type	Description
Credit memo ID	credit_memo_id	True	integer	The system record ID of the credit memo.

Delete a vendor address

Operation ID:: DeleteVendorAddress

Deletes a vendor address.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.
Address ID	address_id	True	integer	The system record ID of the vendor address to delete.

Delete a vendor attachment

Operation ID:: DeleteVendorAttachment

Deletes a vendor attachment.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.
Attachment ID	attachment_id	True	integer	The system record ID of the vendor attachment to delete.

Delete an invoice adjustment

Operation ID:: DeleteInvoiceAdjustment

Deletes an invoice adjustment.

Parameters

Name	Key	Required	Type	Description
Invoice ID	invoice_id	True	integer	The system record ID of the invoice.
Adjustment ID	adjustment_id	True	integer	The system record ID of the invoice adjustment to delete.

Get a purchase order

Operation ID:: GetPurchaseOrder

Returns information about a purchase order.

Parameters

Name	Key	Required	Type	Description
Vendor ID	purchase_order_id	True	integer	The system record ID of the purchase order.

Returns

Purchase order

Body: APApi.PurchaseOrderDetail

Get a purchase order line item

Operation ID:: GetPurchaseOrderLineItem

Returns information about a purchase order line item.

Parameters

Name	Key	Required	Type	Description
Purchase order ID	purchase_order_id	True	integer	The system record ID of the purchase order.
Line item ID	line_item_id	True	integer	The system record ID of the line item.

Returns

Line item

Body: APApi.LineItemDetail

Get a receipt

Operation ID:: GetReceipt

Returns information about a receipt.

Parameters

Name	Key	Required	Type	Description
Receipt ID	receipt_id	True	integer	The system record ID of the receipt.

Returns

Receipt

Body: APApi.ReceiptDetail

Get a vendor

Operation ID:: GetVendor

Returns information about a vendor.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.

Returns

Vendor

Body: APApi.VendorDetail

Get an invoice

Operation ID:: GetInvoice

Returns information about an invoice.

Parameters

Name	Key	Required	Type	Description
Invoice ID	invoice_id	True	integer	The system record ID of the invoice.

Returns

Invoice

Body: APApi.InvoiceDetail

Get an invoice adjustment

Operation ID:: GetInvoiceAdjustment

Returns information about an invoice adjustment.

Parameters

Name	Key	Required	Type	Description
Invoice ID	invoice_id	True	integer	The system record ID of the invoice.
Adjustment ID	adjustment_id	True	integer	The system record ID of the invoice adjustment.

Returns

Invoice adjustment

Body: APApi.InvoiceAdjustmentDetail

Get invoice 1099 info

Operation ID:: GetInvoice1099Amount

Returns the 1099 information for an invoice.

Parameters

Name	Key	Required	Type	Description
Invoice ID	invoice_id	True	integer	The system record ID of the invoice.

Returns

Form 1099

Body: APApi.Form1099

Get vendor 1099 information

Operation ID:: GetVendor1099Info

Get the 1099 information for a vendor.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.

Returns

1099 information

Body: APApi.Vendor1099Information

List invoice 1099 box numbers

Operation ID:: ListInvoice1099BoxNumbers

Lists the 1099 box numbers for an invoice.

Parameters

Name	Key	Required	Type	Description
Invoice ID	invoice_id	True	integer	The system record ID of the invoice.

Returns

Fetching data all at once quickly becomes unmanageable. The collection entity helps by returning paginated chunks of large data sets. This entity includes helpful metadata and properties to paginate and iterate through the data.

Body: APApi.Invoice1099BoxNumberCollection

List invoice adjustments

Operation ID:: ListInvoiceAdjustments

Lists the adjustments for an invoice.

Parameters

Name	Key	Required	Type	Description
Invoice ID	invoice_id	True	integer	The system record ID of the invoice.

Returns

Body: APApi.InvoiceAdjustmentSummaryCollection

List invoices

Operation ID:: ListInvoices

Lists the available invoices.

Parameters

Name	Key	Type	Description
From date	from_date	date-time	Filter the results to invoices dated on or after the specified date.
To date	to_date	date-time	Filter the results to invoices dated on or before the specified date.
Vendor name	vendor_name	string	Search text to match for vendor name.
Status	invoice_status	string	The invoice status.
Post status	post_status	string	The invoice post status.
Payment method	payment_method	string	The invoice payment method.
Search text	search_text	string	Search text to match for vendor name, invoice number, description or purchase order number.
Limit	limit	integer	Represents the number of records to return. The default is 100. The maximum is 500.
Offset	offset	integer	Represents the number of records to skip. For use with pagination.
Added on or after	date_added	date-time	Filter the results to invoices added on or after the specified date.
Added by	added_by	string	Filter the results to invoices added by the specified user.
Modified on or after	last_modified	date-time	Filter the results to invoices modified on or after the specified date.
Modified by	last_modified_by	string	Filter the results to invoices last modified by the specified user.

Returns

Body: APApi.InvoiceSummaryCollection

List purchase order line items

Operation ID:: ListPurchaseOrderLineItems

Lists the line items for a purchase order.

Parameters

Name	Key	Required	Type	Description
Purchase order ID	purchase_order_id	True	integer	The system record ID of the purchase order.
Limit	limit		integer	Represents the number of records to return. The default is 100. The maximum is 500.
Offset	offset		integer	Represents the number of records to skip. For use with pagination.

Returns

Body: APApi.LineItemSummaryCollection

List purchase orders

Operation ID:: ListPurchaseOrders

Lists the available purchase orders.

Parameters

Name	Key	Type	Description
From date	from_date	date-time	Filter the results to purchase orders dated on or after the specified date.
To date	to_date	date-time	Filter the results to purchase orders dated on or before the specified date.
Type	type	string	The purchase order type.
Search text	search_text	string	Search text to match for vendor name or purchase order number.
Limit	limit	integer	Represents the number of records to return. The default is 100. The maximum is 500.
Offset	offset	integer	Represents the number of records to skip. For use with pagination.

Returns

Body: APApi.PurchaseOrderSummaryCollection

List receipts

Operation ID:: ListReceipts

Lists the available receipts.

Parameters

Name	Key	Type	Description
Purchase order ID	purchase_order_id	integer	Filter the results to receipts associated with the specified purchase order.
Received by	received_by	string	Filter the results to receipts received by the specified user.
From date	from_date	date-time	Filter the results to receipts dated on or after the specified date.
To date	to_date	date-time	Filter the results to receipts dated on or before the specified date.
Vendor name	vendor_name	string	Search text to match for vendor name.
Search text	search_text	string	Search text to match for receipt description, receipt number, receipt date, purchase order number, or invoice number.
Limit	limit	integer	Represents the number of records to return. The default is 100. The maximum is 500.
Offset	offset	integer	Represents the number of records to skip. For use with pagination.

Returns

Body: APApi.ReceiptSummaryCollection

List vendor address contact methods

Operation ID:: ListVendorAddressContactMethods

Lists the contact methods for a vendor address.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.
Address ID	address_id	True	integer	The system record ID of the vendor address.

Returns

Body: APApi.VendorAddressContactMethodCollection

List vendor addresses

Operation ID:: ListVendorAddresses

Lists the addresses for a vendor.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.

Returns

Body: APApi.VendorAddressCollection

List vendor attachments

Operation ID:: ListVendorAttachments

Lists the attachments for a vendor.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.

Returns

Body: APApi.AttachmentSummaryCollection

List vendor contacts

Operation ID:: ListVendorContacts

Lists the contacts for a vendor.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.

Returns

Body: APApi.VendorContactCollection

List vendor default distributions

Operation ID:: ListVendorDefaultDistributions

Lists the default distributions for a vendor.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.
Limit	limit		integer	Represents the number of records to return. The default is 100. The maximum is 500.
Offset	offset		integer	Represents the number of records to skip. For use with pagination.

Returns

Distributions

Body: APApi.DefaultDistributionCollection

List vendor notes and actions

Operation ID:: ListVendorNotesActions

Lists the notes and actions for a vendor.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.

Returns

Body: APApi.VendorNoteActionCollection

List vendors

Operation ID:: ListVendors

Lists the available vendors.

Parameters

Name	Key	Type	Description
Status	status	string	The vendor status.
Vendor name	vendor_name	string	Search text to match for vendor name.
Vendor ID	ui_vendor_id	string	The user-visible identifier for the vendor.
Customer number	customer_number	string	The customer number for the vendor.
Limit	limit	integer	Represents the number of records to return. The default is 100. The maximum is 500.
Offset	offset	integer	Represents the number of records to skip. For use with pagination.
Added on or after	date_added	date-time	Filter the results to vendors added on or after the specified date.
Added by	added_by	string	Filter the results to vendors added by the specified user.
Modified on or after	last_modified	date-time	Filter the results to vendors modified on or after the specified date.
Modified by	last_modified_by	string	Filter the results to vendors last modified by the specified user.

Returns

Body: APApi.VendorSummaryCollection

Update a vendor

Operation ID:: EditVendor

Updates a vendor.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor to update.
Name	vendor_name		string	The vendor name. Character limit: 60.
Type	vendor_type		string	The type of vendor.
Customer number	customer_number		string	The vendor customer number.
Status	vendor_status		string	The vendor status.
Issue 1099 statement?	issue_1099s		boolean	Issue a 1099 statement for the vendor?
Credit limit?	has_credit_limit		boolean	Does the payment default have a credit limit?
Credit limit amount	credit_limit		decimal	The payment default credit limit.
Payment terms	payment_terms		string	The terms of the payment (NET).
Payment account	account_name		string	The account from which to pay invoices.
Payment method	payment_method		string	The payment method.
Payment option	payment_option		string	The payment option.

Returns

Created vendor

Body: APApi.CreatedVendor

Update a vendor address

Operation ID:: EditVendorAddress

Updates a vendor address.

Parameters

Name	Key	Required	Type	Description
Vendor ID	vendor_id	True	integer	The system record ID of the vendor.
Address ID	address_id	True	integer	The system record ID of the vendor address to update.
Description	description		string	The address description.
Country	country		string	The country of the address.
Address lines	address_line		string	The street/address lines for the address. Character limit: 150.
City	city		string	The city of the address.
State	state		string	The state or province (or suburb in NZ) for the address.
Postal code	postal		string	The postal code or ZIP of the address. Character limit: 12.
County	county		string	The county of the address.
Is primary?	is_primary		boolean	Is this the vendor's primary address?
Send invoices?	is_invoices		boolean	Send invoices to this address?
Send POs?	is_pos		boolean	Send purchase orders to this address?
Send 1099s?	issue_1099s		boolean	Send 1099s to this address?
Contact title	title		string	The title of the primary contact.
Contact first name	first_name		string	The first name of the primary contact.
Contact middle name	middle_name		string	The middle initial or name of the primary contact.
Contact last name	last_name		string	The last name of the primary contact.
Contact suffix	suffix		string	The suffix of the primary contact.
Contact position	position		string	The position of the primary contact.

Returns

Created vendor address

Body: APApi.CreatedVendorAddress

Update an invoice

Operation ID:: EditInvoice

Updates an invoice.

Parameters

Name	Key	Required	Type	Description
Invoice ID	invoice_id	True	integer	The system record ID of the invoice to update.
Invoice number	invoice_number		string	The invoice number.
Invoice date	invoice_date		date	The invoice date (ex: '2005-09-18').
Due date	due_date		date	The invoice due date (ex: '2005-09-18').
Post status	post_status		string	The post status for the invoice.
Post date	post_date		date	The invoice post date (ex: '2005-09-18').
Amount	amount		decimal	The invoice amount.
Description	description		string	The invoice description.
Approval status	status		string	The approval status for the invoice.
Distribute discounts?	distribute_discounts		boolean	Distribute discounts to invoice expense accounts?
Payment method	payment_method		string	The invoice payment method.
Remit to	address_id		integer	The remit to address for the invoice.
Paid from	paid_from		string	The bank from which the invoice is paid.
Card account ID	credit_card_account_id		integer	The system record ID of the credit card account from which the invoice is paid.
Card ID	credit_card_id		integer	The system record ID of the credit card from which the invoice is paid.
Hold payment?	hold_payment		boolean	Hold payment on this invoice?
Separate payment?	create_separate_payment		boolean	Always create a separate payment for this invoice?

Returns

Created invoice

Body: APApi.CreatedInvoice

Definitions

APApi.AddressContactMethod

Address contact method

Name	Path	Type	Description
ID	contact_method_id	integer	The system record ID of the address contact method.
type	contact_type	string	The contact method type.
information	contact_info	string	The contact method information.

APApi.AttachmentSummary

Attachment

Name	Path	Type	Description
ID	id	integer	The system record ID of the attachment.
Type	type	string	The attachment type.
Name	name	string	The name of the attachment.
URL	url	string	The URL for the attachment. Only applicable for link attachments.
Attachment type	media_type	string	User-defined category of this attachment.
date_attached	date_attached	date-time	The date the attachment was added.

APApi.AttachmentSummaryCollection

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters.
value	value	array of APApi.AttachmentSummary	The set of items included in the response. This may be a subset of the items in the collection.

APApi.CreatedInvoice

Created invoice

Name	Path	Type	Description
ID	record_id	integer	The ID of the newly created invoice.

APApi.CreatedInvoiceAttachment

Created invoice attachment

Name	Path	Type	Description
ID	record_id	integer	The ID of the newly created attachment.

APApi.CreatedPurchaseOrder

Created purchase order

Name	Path	Type	Description
ID	record_id	integer	The ID of the newly created purchase order.

APApi.CreatedVendor

Created vendor

Name	Path	Type	Description
ID	record_id	integer	The ID of the newly created vendor.

APApi.CreatedVendorAction

Created vendor action

Name	Path	Type	Description
ID	record_id	integer	The ID of the newly created vendor action.

APApi.CreatedVendorAddress

Created vendor address

Name	Path	Type	Description
ID	record_id	integer	The ID of the newly created vendor address.

APApi.CreatedVendorAddressContactMethod

Created vendor address contact method

Name	Path	Type	Description
ID	record_id	integer	The ID of the newly created vendor address contact method.

APApi.CreatedVendorAttachment

Created vendor attachment

Name	Path	Type	Description
ID	record_id	integer	The ID of the newly created attachment.

APApi.CreatedVendorNote

Created vendor note

Name	Path	Type	Description
ID	record_id	integer	The ID of the newly created vendor note.

APApi.CustomField

An object containing the custom field details.

Name	Path	Type	Description
name	field_name	string	The name of the custom field.
type	type	string	The type of data that the custom field represents.
value	value	string	The value of the custom field.
is required?	is_required	boolean	Is the custom field required?
date	date	date-time	The date on the custom field.
comment	comments	string	The comment on the custom field.

APApi.DefaultDistribution

Distribution

Name	Path	Type	Description
ID	distribution_id	integer	The distribution identifier.
Type	type_code	string	The journal entry transaction type for the distribution.
Account number	account_number	string	The account number for the distribution.
Percent	percent	decimal	The distribution journal entry amount percentage.
Split	default_distribution_splits	array of APApi.DefaultDistributionSplit	The list of splits for the default distribution.
Custom field	custom_fields	array of APApi.CustomField	The list of custom fields for the distribution.

APApi.DefaultDistributionCollection

Distributions

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters.
value	value	array of APApi.DefaultDistribution	The set of items included in the response. This may be a subset of the items in the collection.

APApi.DefaultDistributionSplit

Split

Name	Path	Type	Description
ID	distribution_split_id	integer	The distribution split identifier.
percent	percent	decimal	The distribution journal entry amount percentage.
project	ui_project_id	string	The user-visible identifier of the project for the distribution split.
Class	account_class	string	The account class for the distribution split.
transaction_code_values	transaction_code_values	array of APApi.TransactionCodeValue	The distribution transaction code values.

APApi.Distribution

An object containing the distribution details.

Name	Path	Type	Description
ID	distribution_id	integer	The distribution identifier.
type	type_code	string	The journal entry transaction type for the distribution.
account number	account_number	string	The account number for the distribution.
amount	amount	decimal	The distribution journal entry amount.
description	description	string	The description for the distribution.
split	distribution_splits	array of APApi.DistributionSplit	The list of splits for the distribution.
custom field	custom_fields	array of APApi.CustomField	The list of custom fields for the distribution.

APApi.DistributionSplit

split

Name	Path	Type	Description
ID	distribution_split_id	integer	The distribution split identifier.
amount	amount	decimal	The distribution journal entry amount.
project	ui_project_id	string	The user-visible identifier of the project for the distribution split.
class	account_class	string	The account class for the distribution split.
transaction_code_values	transaction_code_values	array of APApi.TransactionCodeValue	The distribution transaction code values.

APApi.Form1099

Form 1099

Name	Path	Type	Description
Amount	amount	decimal	The amount distributed to 1099.
Excluded amount	excluded_amount	decimal	The amount excluded from 1099.

APApi.InvoiceAdjustmentDetail

Invoice adjustment

Name	Path	Type	Description
ID	adjustment_id	integer	The invoice adjustment identifier.
Date	adjustment_date	date-time	The date of the invoice adjustment.
Post status	post_status	string	The post status for the invoice adjustment.
Post date	post_date	date-time	The post date for the invoice adjustment.
Reason	reason	string	The reason for the invoice adjustment.
Notes	notes	string	The notes for the invoice adjustment.
count	adjustment_distributions.count	integer	The number of items available for retrieval into the collection after applying any request parameters.
value	adjustment_distributions.value	array of APApi.Distribution	The list of distributions for the invoice adjustment.

APApi.InvoiceAdjustmentSummary

Invoice adjustment

Name	Path	Type	Description
ID	adjustment_id	integer	The invoice adjustment identifier.
Date	adjustment_date	date-time	The date of the invoice adjustment.
Post status	post_status	string	The post status for the invoice adjustment.
Post date	post_date	date-time	The post date for the invoice adjustment.
Reason	reason	string	The reason for the invoice adjustment.
Notes	notes	string	The notes for the invoice adjustment.

APApi.InvoiceAdjustmentSummaryCollection

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters.
value	value	array of APApi.InvoiceAdjustmentSummary	The set of items included in the response. This may be a subset of the items in the collection.

APApi.InvoiceDetail

Invoice

Name	Path	Type	Description
ID	invoice_id	integer	The system record ID of the invoice.
Vendor ID	vendor_id	integer	The system record ID of the vendor.
Name	vendor_name	string	The vendor name.
Invoice number	invoice_number	string	The invoice number.
Invoice date	invoice_date	date-time	The date of the invoice.
Due date	due_date	date	The invoice due date (ex: '2005-09-18').
Post status	post_status	string	The invoice post status.
Post date	post_date	date	The invoice post date (ex: '2005-09-18').
Amount	amount	decimal	The amount of the invoice.
Total paid	total_paid	decimal	The total amount paid on the invoice.
Balance	balance	decimal	The current balance on the invoice.
Description	description	string	The description of the invoice.
Approval status	status	string	The approval status for the invoice.
Distribute discounts?	distribute_discounts	boolean	Distribute discounts to invoice expense accounts?
Purchase order number	purchase_order_number	string	The purchase order number associated with the invoice.
Payment method	invoice_payment_detail.payment_method	string	The invoice payment method.
address ID	invoice_payment_detail.remit_to.address_id	integer	The system record ID of the remit to address for the invoice.
description	invoice_payment_detail.remit_to.description	string	The address description.
country	invoice_payment_detail.remit_to.country	string	The country of the address.
address lines	invoice_payment_detail.remit_to.address_line	string	The street/address lines for the address.
city	invoice_payment_detail.remit_to.city	string	The city of the address.
state	invoice_payment_detail.remit_to.state	string	The state or province (or suburb in NZ) for the address.
postal code	invoice_payment_detail.remit_to.postal	string	The postal code or ZIP of the address.
county	invoice_payment_detail.remit_to.county	string	The county of the address.
contact name	invoice_payment_detail.remit_to.contact_name	string	The full name of the contact for the address.
Paid from	invoice_payment_detail.paid_from	string	The bank from which the invoice is paid.
Card account ID	invoice_payment_detail.credit_card_account_id	integer	The system record ID of the credit card account from which the invoice is paid.
Card account name	invoice_payment_detail.credit_card_account_name	string	The name of the credit card account from which the invoice is paid.
Card ID	invoice_payment_detail.credit_card_id	integer	The system record ID of the credit card from which the invoice is paid.
Card name	invoice_payment_detail.credit_card_name	string	The name of the credit card from which the invoice was paid.
Hold payment?	invoice_payment_detail.hold_payment	boolean	Hold payment on this invoice?
Separate payment?	invoice_payment_detail.create_separate_payment	boolean	Always create a separate payment for this invoice?
Payment	invoice_payment_detail.payments	array of APApi.InvoicePaymentSummary	The list of payments on the invoice.
Distribution	distributions	array of APApi.Distribution	The list of distributions for the invoice.
Custom field	custom_fields	array of APApi.CustomField	The list of custom fields for the invoice.
Date added	date_added	date-time	The date when the invoice was created.
Added by	added_by	string	The name of the user who created the invoice.
Date modified	date_modified	date-time	The date when the invoice was last modified.
Modified by	modified_by	string	The name of the user who last modified the invoice.

APApi.InvoicePaymentSummary

An object containing summary information about a payment for the invoice.

Name	Path	Type	Description
transaction ID	br_transaction_id	integer	The transaction ID for the payment.
transaction number	transaction_number	string	The transaction number for this payment.
date	payment_date	date-time	The date for this payment (ex: '2005-09-18').
status	payment_status	string	The status of the payment.
amount	amount	decimal	The amount of the payment.
checks identifier	checks_7_id	integer	The checks identifier from Financial Edge 7.

APApi.InvoiceSummary

Invoice

Name	Path	Type	Description
ID	invoice_id	integer	The system record ID of the invoice.
Vendor ID	vendor_id	integer	The system record ID of the vendor.
Name	vendor_name	string	The vendor name.
Vendor status	vendor_status	string	The vendor status.
Invoice number	invoice_number	string	The invoice number.
Invoice date	invoice_date	date-time	The date of the invoice.
Description	description	string	The description of the invoice.
Amount	amount	decimal	The amount of the invoice.
Amount due	amount_due	decimal	The amount still due on the invoice.
Balance	balance	decimal	The current balance on the invoice.
Status	status	string	The invoice status.
Post status	post_status	string	The invoice post status.
Payment method	payment_method	string	The invoice payment method.
Age	age	string	The age of the invoice.
Is past due?	is_past_due	boolean	Is the invoice past due?
Purchase order number	purchase_order_number	string	The purchase order number associated with the invoice.
GST tax type	gst_tax_type	string	The tax type for the invoice (only applicable for CA and AU versions).
Date added	date_added	date-time	The date when the invoice was created.
Added by	added_by	string	The name of the user who created the invoice.
Date modified	date_modified	date-time	The date when the invoice was last modified.
Modified by	modified_by	string	The name of the user who last modified the invoice.

APApi.InvoiceSummaryCollection

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters.
value	value	array of APApi.InvoiceSummary	The set of items included in the response. This may be a subset of the items in the collection.

APApi.Invoice1099BoxNumber

Box number

Name	Path	Type	Description
Box number	number	string	The box number.
State	state	string	The state for the box number.
Percent	percent	decimal	The box number percent.
Amount	amount	decimal	The box number amount.

APApi.Invoice1099BoxNumberCollection

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters.
results	results	array of APApi.Invoice1099BoxNumber	The set of items included in the response. This may be a subset of the items in the collection.

APApi.LineItemDetail

Line item

Name	Path	Type	Description
Vendor ID	vendor_id	integer	The vendor identifier for the purchase order line item.
Vendor name	vendor_name	string	The vendor name for the purchase order line item.
Order number	order_number	integer	The purchase order number.
ID	line_item_id	integer	The line item identifier.
Line number	line_number	integer	The number of the line item.
Type	type	string	The line item type.
Product ID	product_id	integer	The product identifier of the line item.
Product code	product_code	string	The product code of the line item.
Vendor part number	vendor_part_number	string	The vendor part number of the line item.
Description	description	string	The description of the line item.
Unit of measure	unit_of_measure	string	The unit of measure of the line item.
Quantity ordered	quantity_ordered	decimal	The quantity ordered of the line item.
Quantity received	quantity_received	decimal	The quantity received of the line item.
Quantity rejected	quantity_rejected	decimal	The quantity rejected of the line item.
Quantity cancelled	quantity_cancelled	decimal	The quantity cancelled of the line item.
Unit cost	unit_cost	decimal	The unit of cost of the line item.
Extended cost	extended_cost	decimal	The extended cost of the line item.
Post status	post_status	string	The line item post status.
Post date	post_date	date-time	The post date of the line item.
Comments	comments	string	The comments of the line item.
Status	status	string	The receipt status of the line item.
Department	department	string	The department of the line item.
Deliver to	deliver_to	string	The staff member to deliver to for the line item.
Distribution	distributions	array of APApi.Distribution	The list of distributions for the line item.
Date added	date_added	date-time	The date when the line item was added.
Added by	added_by	string	The name of the user who added the line item.
Date modified	date_modified	date-time	The date when the line item was last modified.
Modified by	modified_by	string	The name of the user who last modified the line item.

APApi.LineItemSummary

Line item

Name	Path	Type	Description
ID	line_item_id	integer	The line item identifier.
Line number	line_number	integer	The number of the line item.
Type	type	string	The line item type.
Product ID	product_id	integer	The product identifier of the line item.
Product code	product_code	string	The product code of the line item.
Vendor part number	vendor_part_number	string	The vendor part number of the line item.
Description	description	string	The description of the line item.
Unit of measure	unit_of_measure	string	The unit of measure of the line item.
Quantity ordered	quantity_ordered	decimal	The quantity ordered of the line item.
Quantity received	quantity_received	decimal	The quantity received of the line item.
Quantity rejected	quantity_rejected	decimal	The quantity rejected of the line item.
Quantity cancelled	quantity_cancelled	decimal	The quantity cancelled of the line item.
Unit cost	unit_cost	decimal	The unit of cost of the line item.
Extended cost	extended_cost	decimal	The extended cost of the line item.
Post status	post_status	string	The line item post status.
Post date	post_date	date-time	The post date of the line item.
Comments	comments	string	The comments of the line item.
Status	status	string	The receipt status of the line item.
Department	department	string	The department of the line item.
Deliver to	deliver_to	string	The staff member to deliver to for the line item.
Date added	date_added	date-time	The date when the line item was added.
Added by	added_by	string	The name of the user who added the line item.
Date modified	date_modified	date-time	The date when the line item was last modified.
Modified by	modified_by	string	The name of the user who last modified the line item.

APApi.LineItemSummaryCollection

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters.
value	value	array of APApi.LineItemSummary	The set of items included in the response. This may be a subset of the items in the collection.

APApi.PurchaseOrderDetail

Purchase order

Name	Path	Type	Description
ID	purchase_order_id	integer	The system record ID of the purchase order.
Vendor ID	vendor_id	integer	The system record ID of the vendor.
Name	vendor_name	string	The vendor name.
Type	type	string	The purchase order type.
Order number	order_number	integer	The purchase order number.
Order date	order_date	date-time	The date of the purchase order.
Status	order_status	string	The purchase order status.
Order from contact ID	ordered_from_contact_id	integer	The contact identifier for the orderer of the purchase order.
Ship via	ship_via	string	The shipping method of the purchase order.
FOB	fob	string	The freight on board of the purchase order.
Terms	terms	string	The purchase order terms.
Buyer	buyer	string	The buyer of the purchase order.
Department	department	string	The department of the purchase order.
Confirm to	ordered_by	string	The orderer of the purchase order.
Ship to	ship_to_address	string	The ship to address of the purchase order.
Attention	attention	string	The staff member for attention of the purchase order.
Comments	comments	string	The purchase order comments.
Total	order_total	decimal	The total of the purchase order.
Receipted total	receipted_total	decimal	The receipted total of the purchase order.
Date added	date_added	date-time	The date when the purchase order was created.
Custom field	custom_fields	array of APApi.CustomField	The list of custom fields for the purchase order.
Added by	added_by	string	The name of the user who created the purchase order.
Date modified	date_modified	date-time	The date when the purchase order was last modified.
Modified by	modified_by	string	The name of the user who last modified the purchase order.

APApi.PurchaseOrderSummary

Purchase order

Name	Path	Type	Description
ID	purchase_order_id	integer	The system record ID of the purchase order.
Vendor ID	vendor_id	integer	The system record ID of the vendor.
Name	vendor_name	string	The vendor name.
Type	type	string	The purchase order type.
Order number	order_number	integer	The purchase order number.
Order date	order_date	date-time	The date of the purchase order.
Status	order_status	string	The purchase order status.
Total	order_total	decimal	The total of the purchase order.
Receipted total	receipted_total	decimal	The receipted total of the purchase order.
Terms	terms	string	The purchase order terms.
Date added	date_added	date-time	The date when the purchase order was created.
Added by	added_by	string	The name of the user who created the purchase order.
Date modified	date_modified	date-time	The date when the purchase order was last modified.
Modified by	modified_by	string	The name of the user who last modified the purchase order.

APApi.PurchaseOrderSummaryCollection

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters.
value	value	array of APApi.PurchaseOrderSummary	The set of items included in the response. This may be a subset of the items in the collection.

APApi.ReceiptDetail

Receipt

Name	Path	Type	Description
ID	receipt_id	integer	The system record ID of the receipt.
Receipt number	receipt_number	integer	The receipt number.
Received by	received_by	string	The receiver of the receipt.
Receipt date	receipt_date	date-time	The date of the receipt.
Description	description	string	The description of the receipt.
Receipt total	receipt_total	decimal	The total amount of the receipt.
Vendor ID	vendor_id	integer	The system record ID of the vendor.
Name	vendor_name	string	The vendor name.
Purchase order ID	purchase_order_id	integer	The system record ID of the purchase order associated with the receipt.
Purchase order number	purchase_order_number	string	The purchase order number associated with the receipt.
Invoice ID	invoice_id	integer	The system record ID of the invoice associated with the receipt.
Invoice number	invoice_number	string	The invoice number associated with the receipt.
Date added	date_added	date-time	The date when the receipt was created.
Added by	added_by	string	The name of the user who created the receipt.
Date modified	date_modified	date-time	The date when the receipt was last modified.
Modified by	modified_by	string	The name of the user who last modified the receipt.

APApi.ReceiptSummary

Receipt

Name	Path	Type	Description
ID	receipt_id	integer	The system record ID of the receipt.
Receipt number	receipt_number	integer	The receipt number.
Received by	received_by	string	The receiver of the receipt.
Receipt date	receipt_date	date-time	The date of the receipt.
Description	description	string	The description of the receipt.
Receipt total	receipt_total	decimal	The total amount of the receipt.
Vendor ID	vendor_id	integer	The system record ID of the vendor.
Name	vendor_name	string	The vendor name.
Purchase order ID	purchase_order_id	integer	The system record ID of the purchase order associated with the receipt.
Purchase order number	purchase_order_number	string	The purchase order number associated with the receipt.
Invoice ID	invoice_id	integer	The system record ID of the invoice associated with the receipt.
Invoice number	invoice_number	string	The invoice number associated with the receipt.
Date added	date_added	date-time	The date when the receipt was created.
Added by	added_by	string	The name of the user who created the receipt.
Date modified	date_modified	date-time	The date when the receipt was last modified.
Modified by	modified_by	string	The name of the user who last modified the receipt.

APApi.ReceiptSummaryCollection

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters.
value	value	array of APApi.ReceiptSummary	The set of items included in the response. This may be a subset of the items in the collection.

APApi.TransactionCodeValue

Transaction code value

Name	Path	Type	Description
ID	id	integer	The transaction code value ID.
Value	name	string	The transaction code name.
Value	value	string	The transaction code value.
Inactive?	inactive	boolean	Is the transaction code value inactive?

APApi.Vendor1099Information

1099 information

Name	Path	Type	Description
default_box_numbers	default_box_numbers	array of APApi.VendorDefaultBoxNumber	The default box numbers for the vendor.

APApi.VendorAddress

Vendor address

Name	Path	Type	Description
ID	address_id	integer	The address identifier.
Description	description	string	The address description.
Country	country	string	The country of the address.
Address lines	address_line	string	The street/address lines for the address.
City	city	string	The city of the address.
State	state	string	The state or province (or suburb in NZ) for the address.
Postal code	postal	string	The postal code or ZIP of the address.
County	county	string	The county of the address.
Is primary?	is_primary	boolean	Is this the vendor's primary address?
Send invoices?	is_invoices	boolean	Send invoices to this address?
Send POs?	is_pos	boolean	Send purchase orders to this address?
Send 1099s?	is_1099	boolean	Send 1099s to this address?
Payee name	payee_name	string	The payee name.
Contact title	title	string	The title for the primary contact.
Contact first name	first_name	string	The first name of the primary contact.
Contact middle name	middle_name	string	The middle initial or name of the primary contact.
Contact last name	last_name	string	The last name of the primary contact.
Contact suffix	suffix	string	The suffix of the primary contact.
Contact position	position	string	The position of the primary contact.
Contact method	address_contact_methods	array of APApi.AddressContactMethod	The list of contact methods for the address.

APApi.VendorAddressCollection

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters.
results	results	array of APApi.VendorAddress	The set of items included in the response. This may be a subset of the items in the collection.

APApi.VendorAddressContactMethod

Vendor address contact method

Name	Path	Type	Description
ID	contact_method_id	integer	The address contact method identifier.
Contact type	contact_type	string	The contact type.
Contact info	contact_info	string	The contact information.

APApi.VendorAddressContactMethodCollection

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters.
results	results	array of APApi.VendorAddressContactMethod	The set of items included in the response. This may be a subset of the items in the collection.

APApi.VendorContact

Contact

Name	Path	Type	Description
ID	vendor_contact_id	integer	The system record ID of the contact.
Name	contact_display_name	string	The display name for the contact.
Address description	address_description	string	The address description for the contact.
Address	address_line	string	The address lines for the contact.

APApi.VendorContactCollection

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters.
value	value	array of APApi.VendorContact	The set of items included in the response. This may be a subset of the items in the collection.

APApi.VendorDefaultBoxNumber

Box number

Name	Path	Type	Description
Box number	number	string	The box number.
Reporting state	state	string	The reporting state for the box number.
Percent	percent	decimal	The percent for the box number.

APApi.VendorDetail

Vendor

Name	Path	Type	Description
ID	vendor_id	integer	The system record ID of the vendor.
Vendor ID	ui_defined_id	string	The user-defined identifier for the vendor.
Tax ID number	tax_id_number	string	The vendor tax ID number.
PSB activity code ID	psb_activity_code_id	integer	The PSB activity code ID for the vendor (only applicable for CA versions).
PSB activity code	psb_activity_code	string	The PSB activity code for the vendor (only applicable for CA versions).
PSB activity code description	psb_activity_code_desc	string	The PSB activity code description for the vendor (only applicable for CA versions).
GST tax type	gst_tax_type	string	The GST tax type for the vendor (only applicable for CA and AU versions).
GST tax type description	gst_tax_type_desc	string	The GST tax type description for the vendor (only applicable for CA and AU versions).
GST branch	gst_branch	string	The branch for the vendor (only applicable for AU versions).
Name	vendor_name	string	The vendor name.
Type	vendor_type	string	The type of vendor.
Customer number	customer_number	string	The vendor customer number.
Status	vendor_status	string	The vendor status.
Issue 1099 statement?	issue_1099s	boolean	Issue a 1099 statement for the vendor?
Balance due	balance_due	decimal	The balance due for the vendor.
Address	addresses	array of APApi.VendorAddress	The list of addresses for the vendor.
Custom field	custom_fields	array of APApi.CustomField	The list of custom fields for the vendor.
Payment default	vendor_payment_default	APApi.VendorPaymentDefault	The vendor's payment defaults.
Date added	date_added	date-time	The date when the vendor was created.
Added by	added_by	string	The name of the user who created the vendor.
Date modified	date_modified	date-time	The date when the vendor was last modified.
Modified by	modified_by	string	The name of the user who last modified the vendor.

APApi.VendorNoteAction

Note/action

Name	Path	Type	Description
ID	note_action_id	integer	The system record ID of the note or action.
Record type	note_type	string	The record type (note or action).
Type	type	string	The note or action type.
Date	date	date-time	The date of the note or action.
Description	description	string	The note or action description.
Note	content	string	The content of the note.
Assigned to	assign_to	string	The user to whom the action is assigned.
Is complete?	is_complete	boolean	Is the action complete?
Completed on	completed_date	date-time	The action completed date.

APApi.VendorNoteActionCollection

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters.
results	results	array of APApi.VendorNoteAction	The set of items included in the response. This may be a subset of the items in the collection.

APApi.VendorPaymentDefault

The vendor's payment defaults.

Name	Path	Type	Description
credit limit?	has_credit_limit	boolean	Does the payment default have a credit limit?
credit limit amount	credit_limit	decimal	The payment default credit limit.
terms	payment_terms	string	The terms of the payment (NET).
account name	account_name	string	The account from which to pay invoices.
method	payment_method	string	The payment method.
option	payment_option	string	The payment option.

APApi.VendorSummary

Vendor

Name	Path	Type	Description
ID	vendor_id	integer	The system record ID of the vendor.
Vendor ID	ui_defined_id	string	The user-defined identifier for the vendor.
Name	vendor_name	string	The vendor name.
Customer number	customer_number	string	The vendor customer number.
Status	vendor_status	string	The vendor status.
Issue 1099 statement?	issue_1099s	boolean	Issue a 1099 statement for the vendor?
Balance due	balance_due	decimal	The balance due for the vendor.
Payment method	payment_method	string	The default payment method for the vendor.
ID	primary_address.address_id	integer	The system record ID of the address.
description	primary_address.description	string	The address description.
country	primary_address.country	string	The country of the address.
lines	primary_address.address_line	string	The street/address lines for the address.
city	primary_address.city	string	The city of the address.
state	primary_address.state	string	The state or province (or suburb in NZ) for the address.
postal code	primary_address.postal	string	The postal code or ZIP of the address.
county	primary_address.county	string	The county of the address.
is primary?	primary_address.is_primary	boolean	Is this the vendor's primary address?
send invoices?	primary_address.is_invoices	boolean	Send invoices to this address?
send POs?	primary_address.is_pos	boolean	Send purchase orders to this address?
send 1099s?	primary_address.is_1099	boolean	Send 1099s to this address?
contact title	primary_address.title	string	The title for the primary contact.
contact first name	primary_address.first_name	string	The first name of the primary contact.
contact middle name	primary_address.middle_name	string	The middle initial or name of the primary contact.
contact last name	primary_address.last_name	string	The last name of the primary contact.
contact suffix	primary_address.suffix	string	The suffix of the primary contact.
contact position	primary_address.position	string	The position of the primary contact.
address_contact_methods	primary_address.address_contact_methods	array of APApi.AddressContactMethod	The list of contact methods for the address.
Payment default	payment_defaults	APApi.VendorPaymentDefault	The vendor's payment defaults.
Date added	date_added	date-time	The date when the vendor was created.
Added by	added_by	string	The name of the user who created the vendor.
Date modified	date_modified	date-time	The date when the vendor was last modified.
Modified by	modified_by	string	The name of the user who last modified the vendor.

APApi.VendorSummaryCollection

Name	Path	Type	Description
Count	count	integer	The number of items available for retrieval into the collection after applying any request parameters.
value	value	array of APApi.VendorSummary	The set of items included in the response. This may be a subset of the items in the collection.

Compartir a través de

Blackbaud FENXT Payable (Preview)

Prerequisites

How to get credentials?

Known issues and limitations

Throttling Limits

Actions

Create a purchase order

Parameters

Returns

Create a purchase order line item

Parameters

Create a vendor

Parameters

Returns

Create a vendor action

Parameters

Returns

Create a vendor address

Parameters

Returns

Create a vendor address contact method

Parameters

Returns

Create a vendor attachment

Parameters

Returns

Create a vendor note

Parameters

Returns

Create an invoice

Parameters

Returns

Create an invoice (single distribution)

Parameters

Returns

Create an invoice attachment

Parameters

Returns

Delete a credit memo

Parameters

Delete a vendor address

Parameters

Delete a vendor attachment

Parameters

Delete an invoice adjustment

Parameters

Get a purchase order

Parameters

Returns

Get a purchase order line item

Parameters

Returns

Get a receipt

Parameters

Returns

Get a vendor

Parameters

Returns

Get an invoice

Parameters

Returns

Get an invoice adjustment

Parameters

Returns

Get invoice 1099 info

Parameters

Returns

Get vendor 1099 information

Parameters

Returns

List invoice 1099 box numbers

Parameters

Returns

List invoice adjustments

Parameters

Returns

List invoices

Parameters

Returns