Create

POST

Request

This endpoint expects an object.
Invoice Creation with Entity Requestobject
OR
Invoice Creation with Entity Group Requestobject

Response

This endpoint returns an object.
idstring
statusenum
paymentDestinationConfirmedboolean

True if the payment destination has been confirmed by the vendor. False if the payment destination has been set (for example, a check to an address) but has not been confirmed by the vendor.

hasDocumentsboolean

True if the invoice has documents attached.

hasSourceEmailboolean

True if the invoice was created by an incoming email.

approverslist of objects
approvalPolicylist of objects
metadatamap from strings to strings

Metadata associated with this invoice.

createdAtdatetime
updatedAtdatetime
amountdoubleOptional

Total amount of invoice in major units

currencyenumOptional

Currency code for the amount. Defaults to USD.

invoiceDatedatetimeOptional

Date the invoice was issued.

deductionDatedatetimeOptional

Initial date when funds are scheduled to be deducted from payer’s account. The actual deduction date may differ from this date, and will be reflected in the processedAt field.

nextDeductionDatedatetimeOptional

If this is a recurring invoice, this will be the next date when funds are scheduled to be deducted from payer’s account.

processedAtdatetimeOptional

Date when the invoice payment was processed.

settlementDatedatetimeOptional

Date of funds settlement.

dueDatedatetimeOptional

Due date of invoice.

invoiceNumberstringOptional
noteToSelfstringOptional
serviceStartDatedatetimeOptional
serviceEndDatedatetimeOptional
payerIdstringOptional
payerobjectOptional
paymentSourceobjectOptional
paymentSourceIdstringOptional
vendorIdstringOptional
vendorobjectOptional
paymentDestinationobjectOptional
paymentDestinationIdstringOptional
paymentDestinationOptionsobjectOptional
commentslist of objectsOptional
lineItemslist of objectsOptional
foreignIdstringOptional

The ID used to identify this invoice in your system. This ID must be unique within each creatorEntity in your system, e.g. two invoices with the same creatorEntity may not have the same foreign ID.

creatorEntityIdstringOptional

The ID of the entity who created this invoice.

creatorUserobjectOptional

Entity user who created this invoice.

failureTypeenumOptional
Allowed values: SOURCE_PAYMENT_ERRORDESTINATION_PAYMENT_ERRORREJECTED_HIGH_RISKINSUFFICIENT_FUNDSPROCESSING_ERROR

If the invoice failed to be paid, this field will be populated with the type of failure.

feesobjectOptional

Fees associated with this invoice.

paymentScheduleobjectOptional

If this is a recurring invoice, this will be the payment schedule for the invoice. If not provided, this will be a one-time invoice.