accounting
invoice

Create an invoice

post/accounting/{connection_id}/invoice

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/accounting/{connection_id}/invoice
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

due_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

paid_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

refunded_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

cancelled_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

posted_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

total_amountnumber
paid_amountnumber
refund_amountnumber
tax_amountnumber
discount_amountnumber
balance_amountnumber
invoice_numberstring

External identifier (ie. reference) for this invoice

referencestring
contact_idstring

(reference to AccountingContact)

currencystring
notesstring
refund_reasonstring
term'ON_RECEIPT' | 'NET_7' | 'NET_10' | 'NET_15' | 'NET_20' | 'NET_25' | 'NET_30' | 'NET_45' | 'NET_60' | 'NET_90' | 'OTHER'

@deprecated use payment_terms instead

payment_terms'ON_RECEIPT' | 'NET_7' | 'NET_10' | 'NET_15' | 'NET_20' | 'NET_25' | 'NET_30' | 'NET_45' | 'NET_60' | 'NET_90' | 'OTHER'
paymentterm_idstring
status'DRAFT' | 'VOIDED' | 'AUTHORIZED' | 'PAID' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED' | 'REFUNDED' | 'SUBMITTED' | 'DELETED' | 'OVERDUE'
urlstring

The public URL for the invoice to send to a customer to view or pay.

payment_collection_method'send_invoice' | 'charge_automatically'

When set to charging_automatically, an automated attempt will occur to pay this invoice using the default payment source attached to the contactcustomer. When set to send_invoice, an will email will be sent with this invoice to the contact/customer with payment instructions.

type'INVOICE' | 'CREDITMEMO'

BILL removed (use AccountingBill); remaining values: INVOICE, CREDITMEMO

sendboolean
organization_idstring
category_idsstring[]
project_idstring

(reference to TaskProject)

sub_total_amountnumber

Total before tax

exchange_ratenumber

Exchange rate to the base/home currency at the document date

is_inclusive_of_taxboolean

True when the document amounts already include tax

salesorder_idsstring[]

refs -> AccountingSalesorder; the sales orders this invoice was raised from

rawunknown

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

due_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

paid_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

refunded_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

cancelled_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

posted_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

total_amountnumber
paid_amountnumber
refund_amountnumber
tax_amountnumber
discount_amountnumber
balance_amountnumber
invoice_numberstring

External identifier (ie. reference) for this invoice

referencestring
contact_idstring

(reference to AccountingContact)

currencystring
notesstring
refund_reasonstring
term'ON_RECEIPT' | 'NET_7' | 'NET_10' | 'NET_15' | 'NET_20' | 'NET_25' | 'NET_30' | 'NET_45' | 'NET_60' | 'NET_90' | 'OTHER'

@deprecated use payment_terms instead

payment_terms'ON_RECEIPT' | 'NET_7' | 'NET_10' | 'NET_15' | 'NET_20' | 'NET_25' | 'NET_30' | 'NET_45' | 'NET_60' | 'NET_90' | 'OTHER'
paymentterm_idstring
status'DRAFT' | 'VOIDED' | 'AUTHORIZED' | 'PAID' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED' | 'REFUNDED' | 'SUBMITTED' | 'DELETED' | 'OVERDUE'
urlstring

The public URL for the invoice to send to a customer to view or pay.

payment_collection_method'send_invoice' | 'charge_automatically'

When set to charging_automatically, an automated attempt will occur to pay this invoice using the default payment source attached to the contactcustomer. When set to send_invoice, an will email will be sent with this invoice to the contact/customer with payment instructions.

type'INVOICE' | 'CREDITMEMO'

BILL removed (use AccountingBill); remaining values: INVOICE, CREDITMEMO

sendboolean
organization_idstring
category_idsstring[]
project_idstring

(reference to TaskProject)

sub_total_amountnumber

Total before tax

exchange_ratenumber

Exchange rate to the base/home currency at the document date

is_inclusive_of_taxboolean

True when the document amounts already include tax

salesorder_idsstring[]

refs -> AccountingSalesorder; the sales orders this invoice was raised from

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.