Invoice

Get invoice

Retrieves a single invoice by ID.

get/Invoice/{idInvoice}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Invoice/{idInvoice}
  • Auth: HTTP bearer

Path parameters

idInvoiceinteger required

Invoice ID

Response

Success. Fields marked optional may return null if not set.

invoiceIdinteger required

Identifier of invoice.

customerIdinteger required

The Payabli-generated unique ID for the customer.

paypointIdinteger required

The paypoint's ID. Note that this is different than the entryname.

invoiceNumberstring required

Invoice number. Identifies the invoice under a paypoint.

invoiceDatestring date nullable required
invoiceDueDatestring date nullable required
invoiceSentDatestring date-time nullable required
invoiceEndDatestring date nullable required
lastPaymentDatestring date-time nullable required
createdAtstring date-time required

Timestamp of when record was created, in UTC.

invoiceStatusinteger required

Invoice status code.

invoiceTypeinteger required

Invoice type. Value 0 is for single/one-time invoices, 1 for scheduled invoices.

frequency'onetime' | 'weekly' | 'every2weeks' | 'every6months' | 'monthly' | 'every3months' | 'annually' | 'firstofmonth' | 'fifteenthofmonth' | 'endofmonth' required

Frequency for operation. The firstofmonth, fifteenthofmonth, and endofmonth values are only valid on subscriptions — they aren't accepted by other endpoints (such as invoice scheduling) that use this enum.

paymentTerms'PIA' | 'CIA' | 'UR' | 'NET10' | 'NET20' | 'NET30' | 'NET45' | 'NET60' | 'NET90' | 'EOM' | 'MFI' | '5MFI' | '10MFI' | '15MFI' | '20MFI' | '2/10NET30' | 'UF' | '10UF' | '20UF' | '25UF' | '50UF' required

Payment terms for invoice. If no terms are defined, then response data for this field defaults to NET30.

termsConditionsstring required

Custom terms and conditions included in the invoice.

notesstring nullable required
taxnumber double

Tax rate in percent applied to the invoice.

discountnumber double

Discount applied to the invoice.

invoiceAmountnumber double required

The invoice amount.

invoicePaidAmountnumber double required

Amount partially paid to the invoice.

freightAmountnumber double

Freight/shipping amount.

dutyAmountnumber double

Duty amount.

purchaseOrderstring required

Purchase order number.

firstNamestring

First name of the recipient of the invoice.

lastNamestring

Last name of the recipient of the invoice.

companystring

Company name of the recipient of the invoice.

shippingAddress1string required

The shipping address.

shippingAddress2string required

Additional line for shipping address.

shippingCitystring required

Shipping city.

shippingStatestring required

Shipping state or province.

shippingZipstring required

Shipping ZIP code. For Pay In functions, this field supports 5-digit and 9-digit ZIP codes and alphanumeric Canadian postal codes. For example: 37615-1234 or 37615.

shippingFromZipstring required

Sender shipping ZIP code.

shippingCountrystring required

Shipping address country.

shippingEmailstring email required

Email address.

shippingPhonestring required
summaryCommodityCodestring required

Commodity code.

paylinkIdstring required

Identifier of payment link associated to the invoice or bill.

PaypointLegalnamestring required
PaypointDbanamestring required

The alternate or common name that this business is doing business under, usually referred to as a DBA name.

PaypointEntrynamestring required

The entrypoint identifier.

ParentOrgNamestring required

The name of the parent organization.

AdditionalDataAdditionalDataMap

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using custom identifiers, pass those in this object. Max length for a value is 100 characters.

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}
externalPaypointIDstring

A custom identifier for the paypoint, if applicable.

Changes

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