Update Invoice - Payabli Docs

API Basics

Pay In Endpoints

MoneyIn
Subscription
TokenStorage
Invoice
LineItem
PaymentLink
PaymentMethodDomain
HostedPaymentPages
Cloud
Wallet: Apple Pay

Pay Out Endpoints

MoneyOut
Bill

Pay Ops Endpoints

Templates
Boarding
Chargebacks and ACH Returns
Entities
Notification
Query
Statistic
Export
Import

Object Models

Object Model References

PUT

Invoice

{idInvoice}

curl --request PUT \
  --url https://api-sandbox.payabli.com/api/Invoice/{idInvoice} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "customerData": {
    "customerId": 4440,
    "firstName": "John",
    "lastName": "Doe",
    "company": "Sunshine LLC",
    "customerNumber": "3456-7645A",
    "billingAddress1": "123 Walnut Street",
    "billingAddress2": "STE 900",
    "billingCity": "Johnson City",
    "billingState": "Johnson City",
    "billingZip": "37615",
    "billingCountry": "US",
    "billingPhone": "5555555555",
    "billingEmail": "example@email.com",
    "shippingAddress1": "123 Walnut St",
    "shippingAddress2": "STE 900",
    "shippingCity": "Johnson City",
    "shippingState": "TN",
    "shippingZip": "37619",
    "shippingCountry": "US",
    "additionalData": {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
    },
    "identifierFields": [
      "email"
    ]
  },
  "invoiceData": {
    "invoiceNumber": "INV-2345",
    "invoiceDate": "2024-07-01",
    "invoiceDueDate": "2024-07-01",
    "invoiceType": 0,
    "invoiceEndDate": "2024-07-01",
    "invoiceStatus": 1,
    "frequency": "monthly",
    "paymentTerms": "PIA",
    "termsConditions": "Must be paid before work scheduled.",
    "notes": "Example notes.",
    "tax": 2.05,
    "discount": 10,
    "invoiceAmount": 105,
    "freightAmount": 10,
    "dutyAmount": 0,
    "purchaseOrder": "PO-345",
    "firstName": "Chad",
    "lastName": "Mercia",
    "company": "ACME, INC",
    "shippingAddress1": "123 Walnut St",
    "shippingAddress2": "STE 900",
    "shippingCity": "Johnson City",
    "shippingState": "TN",
    "shippingZip": "37619",
    "shippingCountry": "US",
    "shippingEmail": "example@email.com",
    "shippingPhone": "5555555555",
    "shippingFromZip": "30040",
    "summaryCommodityCode": "501718",
    "items": [
      {
        "itemProductCode": "M-DEPOSIT",
        "itemProductName": "Materials deposit",
        "itemDescription": "Deposit for materials.",
        "itemCommodityCode": "010",
        "itemUnitOfMeasure": "SqFt",
        "itemCost": 5,
        "itemQty": 1,
        "itemMode": 0,
        "itemCategories": [
          "<string>"
        ],
        "itemTotalAmount": 123,
        "itemTaxAmount": 7,
        "itemTaxRate": 0.075
      }
    ],
    "attachments": {},
    "AdditionalData": {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
    }
  },
  "scheduledOptions": {
    "includePaylink": true,
    "includePdf": true
  }
}'

{
  "isSuccess": true,
  "responseText": "Success",
  "responseCode": 1,
  "responseData": 3625,
  "pageidentifier": null
}

Authorizations

requestToken

string

header

required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

idInvoice

integer

required

Invoice ID

Example:

23548884

Query Parameters

forceCustomerCreation

boolean

default:false

When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer.

Body

InvoiceData object with the modified invoice details

customerData

object

Object describing the customer/payor. Required for POST requests. Which fields are required depends on the paypoint's custom identifier settings. See PayorData Object Model for a complete reference.

customerData.customerId

integer | null

The Payabli-generated unique ID for the customer.

Example:

4440

customerData.firstName

string | null

Customer/Payor first name.

Maximum length: 250

Example:

"John"

customerData.lastName

string | null

Customer/Payor last name.

Maximum length: 250

Example:

"Doe"

customerData.company

string | null

Customer's company name.

Maximum length: 250

Example:

"Sunshine LLC"

customerData.customerNumber

string | null

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

Maximum length: 250

Example:

"3456-7645A"

customerData.billingAddress1

string | null

Customer's billing address.

Maximum length: 250

Example:

"123 Walnut Street"

customerData.billingAddress2

string | null

Additional line for Customer's billing address.

Maximum length: 100

Example:

"STE 900"

customerData.billingCity

string | null

Customer's billing city.

Maximum length: 250

Example:

"Johnson City"

customerData.billingState

string | null

Customer's billing state. Must be 2-letter state code for address in US.

Maximum length: 250

Example:

"Johnson City"

customerData.billingZip

string | null

Customer's billing ZIP code.

Maximum length: 50

Example:

"37615"

customerData.billingCountry

string | null

Customer's billing country.

Maximum length: 100

Example:

"US"

customerData.billingPhone

string | null

Customer's phone number.

Maximum length: 50

Example:

"5555555555"

customerData.billingEmail

string | null

Customer's email address.

Maximum length: 320

Example:

"example@email.com"

customerData.shippingAddress1

string | null

The shipping address.

Maximum length: 250

Example:

"123 Walnut St"

customerData.shippingAddress2

string | null

Additional line for shipping address.

Maximum length: 100

Example:

"STE 900"

customerData.shippingCity

string | null

Shipping city.

Maximum length: 250

Example:

"Johnson City"

customerData.shippingState

string | null

Shipping state or province.

Example:

"TN"

customerData.shippingZip

string | null

Shipping ZIP code.

Maximum length: 50

Example:

"37619"

customerData.shippingCountry

string | null

Shipping address country.

Maximum length: 100

Example:

"US"

customerData.additionalData

object

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. Example usage:

{
  "additionalData": {
    "CustomIdentifier": "value",
    "key2": "value2",
    "key3": "value3"
  }
}

Example:

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

customerData.identifierFields

(string | null)[] | null

List of fields acting as customer identifiers, to be used instead of CustomerNumber.

Example:

["email"]

invoiceData

object

Object describing the invoice. Required for POST requests.

invoiceData.invoiceNumber

string | null

Invoice number. Identifies the invoice under a paypoint.

Maximum length: 250

Example:

"INV-2345"

invoiceData.invoiceDate

string | null

Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Example:

"2024-07-01"

invoiceData.invoiceDueDate

string | null

Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Example:

"2024-07-01"

invoiceData.invoiceType

integer | null

Type of invoice. Only 0 for one-time invoices is currently supported.

Example:

0

invoiceData.invoiceEndDate

string | null

Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Example:

"2024-07-01"

invoiceData.invoiceStatus

enum<integer> | null

Status for invoice.

The accepted status values are:

0 draft
1 active
2 partially paid
4 paid/complete
99 cancelled

Available options:

0,

1,

2,

4,

99

Example:

1

invoiceData.frequency

enum<string> | null

Frequency of scheduled invoice.

Available options:

one-time,

weekly,

every2weeks,

every6months,

monthly,

every3months,

annually

Example:

"monthly"

invoiceData.paymentTerms

enum<string> | null

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

Available options:

PIA,

CIA,

UR,

NET10,

NET20,

NET30,

NET45,

NET60,

NET90,

EOM,

MFI,

5MFI,

10MFI,

15MFI,

20MFI,

2/10NET30,

UF,

10UF,

20UF,

25UF,

50UF

Example:

"PIA"

invoiceData.termsConditions

string | null

Custom terms and conditions included in the invoice.

Example:

"Must be paid before work scheduled."

invoiceData.notes

string | null

Notes included in the invoice.

Example:

"Example notes."

invoiceData.tax

number | null

Tax rate in percent applied to the invoice.

Example:

2.05

invoiceData.discount

number | null

Discount applied to the invoice.

Example:

10

invoiceData.invoiceAmount

number | null

Invoice total amount.

Example:

105

invoiceData.freightAmount

number | null

Freight/shipping amount.

Example:

10

invoiceData.dutyAmount

number | null

Duty amount.

Example:

0

invoiceData.purchaseOrder

string | null

Purchase order number.

Example:

"PO-345"

invoiceData.firstName

string | null

First name of the recipient of the invoice.

Example:

"Chad"

invoiceData.lastName

string | null

Last name of the recipient of the invoice.

Example:

"Mercia"

invoiceData.company

string | null

Company name of the recipient of the invoice.

Example:

"ACME, INC"

invoiceData.shippingAddress1

string | null

The shipping address.

Maximum length: 250

Example:

"123 Walnut St"

invoiceData.shippingAddress2

string | null

Additional line for shipping address.

Maximum length: 100

Example:

"STE 900"

invoiceData.shippingCity

string | null

Shipping city.

Maximum length: 250

Example:

"Johnson City"

invoiceData.shippingState

string | null

Shipping state or province.

Example:

"TN"

invoiceData.shippingZip

string | null

Shipping ZIP code.

Maximum length: 50

Example:

"37619"

invoiceData.shippingCountry

string | null

Shipping address country.

Example:

"US"

invoiceData.shippingEmail

string | null

Shipping recipient's contact email address.

Maximum length: 320

Example:

"example@email.com"

invoiceData.shippingPhone

string | null

Recipient phone number.

Example:

"5555555555"

invoiceData.shippingFromZip

string | null

Sender shipping ZIP code.

Example:

"30040"

invoiceData.summaryCommodityCode

string | null

Commodity code.

Example:

"501718"

invoiceData.items

object[] | null

Array of line items included in the invoice.

invoiceData.attachments

object | null

Array of fileContent objects with attached documents. Max upload size is 30 MB.

invoiceData.AdditionalData

string | null

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

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

Example:

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

scheduledOptions

object

Object with options for scheduled invoices.

Response

200

application/json

Success

Response schema for invoice operations.

isSuccess

boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Example:

true

responseText

string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

responseCode

integer | null

Code for the response. Learn more in API Response Codes.

Example:

1

responseData

If isSuccess = true, this contains the identifier of the invoice. If isSuccess = false, this contains the reason for the failure.

pageidentifier

string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

Was this page helpful?

Get Invoice

Delete Invoice

curl --request PUT \
  --url https://api-sandbox.payabli.com/api/Invoice/{idInvoice} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "customerData": {
    "customerId": 4440,
    "firstName": "John",
    "lastName": "Doe",
    "company": "Sunshine LLC",
    "customerNumber": "3456-7645A",
    "billingAddress1": "123 Walnut Street",
    "billingAddress2": "STE 900",
    "billingCity": "Johnson City",
    "billingState": "Johnson City",
    "billingZip": "37615",
    "billingCountry": "US",
    "billingPhone": "5555555555",
    "billingEmail": "example@email.com",
    "shippingAddress1": "123 Walnut St",
    "shippingAddress2": "STE 900",
    "shippingCity": "Johnson City",
    "shippingState": "TN",
    "shippingZip": "37619",
    "shippingCountry": "US",
    "additionalData": {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
    },
    "identifierFields": [
      "email"
    ]
  },
  "invoiceData": {
    "invoiceNumber": "INV-2345",
    "invoiceDate": "2024-07-01",
    "invoiceDueDate": "2024-07-01",
    "invoiceType": 0,
    "invoiceEndDate": "2024-07-01",
    "invoiceStatus": 1,
    "frequency": "monthly",
    "paymentTerms": "PIA",
    "termsConditions": "Must be paid before work scheduled.",
    "notes": "Example notes.",
    "tax": 2.05,
    "discount": 10,
    "invoiceAmount": 105,
    "freightAmount": 10,
    "dutyAmount": 0,
    "purchaseOrder": "PO-345",
    "firstName": "Chad",
    "lastName": "Mercia",
    "company": "ACME, INC",
    "shippingAddress1": "123 Walnut St",
    "shippingAddress2": "STE 900",
    "shippingCity": "Johnson City",
    "shippingState": "TN",
    "shippingZip": "37619",
    "shippingCountry": "US",
    "shippingEmail": "example@email.com",
    "shippingPhone": "5555555555",
    "shippingFromZip": "30040",
    "summaryCommodityCode": "501718",
    "items": [
      {
        "itemProductCode": "M-DEPOSIT",
        "itemProductName": "Materials deposit",
        "itemDescription": "Deposit for materials.",
        "itemCommodityCode": "010",
        "itemUnitOfMeasure": "SqFt",
        "itemCost": 5,
        "itemQty": 1,
        "itemMode": 0,
        "itemCategories": [
          "<string>"
        ],
        "itemTotalAmount": 123,
        "itemTaxAmount": 7,
        "itemTaxRate": 0.075
      }
    ],
    "attachments": {},
    "AdditionalData": {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
    }
  },
  "scheduledOptions": {
    "includePaylink": true,
    "includePdf": true
  }
}'

{
  "isSuccess": true,
  "responseText": "Success",
  "responseCode": 1,
  "responseData": 3625,
  "pageidentifier": null
}