Update Buyer Invoice Header

patch

https://{serverName}/j1p/api/public/j1/v2/invoices/{invoiceId}/header

Updates the header information of an existing buyer invoice identified by the specified invoiceId.
Only the fields provided in the request body will be updated; all other header properties remain unchanged.
This endpoint supports partial updates and can be used to modify details such as supplier invoice number,
due date, business unit, payment terms, and custom fields. Updates are only made if all data provided is valid.
The first example will contain all properties that can be updated with this API. The rest will be examples of each property or combination of properties with more detailed explanation
The following examples will show each property that can be updated. You can update any combination of these examples seperately or together.

General validations include:

Valid buyer invoice id must be provided
Invoice must be editable (i.e. invoice can not be in complete status, cancelled status or in an automated workflow step)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

invoiceId

int64

required

This is the JI internal database id for the invoice.

Body Params

supplierInvoiceNumber

string

length between 0 and 100

Tracking number assigned to the invoice by the supplier.

dueDateAt

date

length between 10 and 10

This is the date the invoice payment is due.

businessUnit

string

length between 0 and 30

Internal name of business unit

invoiceOwner

object

billTo

object

shipTo

object

remitTo

object

withholdingTax1

number

-99999999999 to 99999999999

Withholding Tax 1 for invoice. This is a numeric value with up to 4 decimal places that will use existing currency on invoice

withholdingTax2

number

-99999999999 to 99999999999

Withholding Tax 2 for invoice. This is a numeric value with up to 4 decimal places that will use existing currency on invoice

miscFees

array of objects

length ≥ 0

Misc Fees attached to this document

miscFees

swiftBic

string

length between 0 and 11

A SWIFT code is an international bank code that identifies particular banks worldwide. It's also known as a Bank Identifier Code (BIC). It should be formatted as follows: First four characters = bank code (letters only) Next two characters = alpha country code (letters only) Next two characters = location code (letters and digits; a passive participant should have "1" as the second character) Last three characters (optional) = branch code (letters and digits; "XXX" for primary office).

irc

string

length between 0 and 40

Some countries throughout the international banking community utilize international routing codes, which are used in combination with the SWIFT/BIC to aid in routing the payment through a main office to a branch.

iban

string

length between 0 and 40

International Bank Account Number, if the country is set to other than United States

bankAccountNumber

string

length between 0 and 24

Account number for a particular bank

terms

object

notes

string

length between 0 and 1000

External notes supply extra information about the invoice that can be viewed and added by both buyers and suppliers

paymentStatus

string

enum

indicates payment status of invoice i.e. payable, paid, disputed

Allowed:

recordDateAt

date

length between 10 and 10

This is the date the invoice payment method is made.

recordNumber

string

length between 0 and 100

The customer's transaction or record number for the payment

paymentMethod

string

enum

The payment method from the customer to the supplier. For example, check, ACH, Credit Card, etc.

tax1

number

-99999999999 to 99999999999

Tax 1 for invoice. This is a numeric value with up to 4 decimal places that will use existing currency on invoice

tax2

number

-99999999999 to 99999999999

Tax 2 for invoice. This is a numeric value with up to 4 decimal places that will use existing currency on invoice

shippingCharges

number

-99999999999 to 99999999999

Shipping for invoice. This is a numeric value with up to 4 decimal places that will use existing currency on invoice

handlingCharges

number

-99999999999 to 99999999999

Handling for invoice. This is a numeric value with up to 4 decimal places that will use existing currency on invoice

discountAmount

number

-99999999999 to 99999999999

Discount for invoice. This is a numeric value with up to 4 decimal places that will use existing currency on invoice

customFieldValues

The set of custom fields where values are keyed to the internal name of the custom field. The max size for the key (Custom Field Internal name) is 100 characters.

splittableCustomFieldSetGroups

object

The set of group(s) of splittable custom fields where groups are keyed to format of Group - (Internal Name of the First Custom Field). For example if first custom field is Project Code the key would be Group - Project Code

Responses

204

No Content,indicating that the invoice updated successfully without returning any content

401

Unauthorized. Bearer token was rejected or was not valid.

403

Tenant or user does not have permission to perform the requested operation

404

Not Found. Object referenced by id in URL path does not exist

400Bad Request

500Internal Server Error