Modifying bulk invoices

PATCHable fields

You can modify the following attributes for a bulk invoice:

• bulkInvoiceTotal: This string specifies the amount to be split evenly across all invoice items, or zero if item amounts are to be entered individually.
• deliveryMethod: This object specifies the delivery method for the bulk invoice. You can modify the code within the object to change the delivery method. For example, you can change the code from send to hold to put a bulk invoice on hold.
• currency: This object specifies the currency for the bulk invoice. You can modify the code within the object to change the currency. For example, you can change the code from usd to jpy to change the currency to from US dollars to Japanese yen.
• invoiceNumber: This string is the human-readable name for the bulk invoice, visible to users in ClaimCenter.
• mailTo: This string is the name of the recipient for the mail containing the bulk invoice.
• payeeAddressBookUID: This string is the identifier for the bulk invoice's payee. Changing it will change all the payee information for the bulk invoice.
• paymentMethod: This object specifies the payment method for the bulk invoice. You can modify the code within the object to change the payment method. For example, you can change the code from check to eft to change the payment method from a check to an EFT (Electronic Funds Transfer).
• reportability: This object specifies whether the bulk invoice is tax-reportable. You can modify the code within the object to change the reportability. For example, you can change the code from notreportable to reportable to indicate that the bulk invoice is tax-reportable.
• scheduledSendDate: This date-time represents the date and time that the bulk invoice will be submitted to the downstream system.
• splitEqually: This Boolean designates whether the amount for each individual line-item will be automatically calculated as an even share of the total amount.

Bulk invoice modification examples

The following request updates the bulkInvoiceTotal, a string, for a bulk invoice:

Command

PATCH /claim/v1/bulk-invoices/xc:SdLxd3WOhsS0mT2Vi1XEu

Request

{
    "data": {
        "attributes": {
            "bulkInvoiceTotal": "3000.00"
        }
    }
}

When the request is successful, the API responds with the updated bulk invoice and its new bulk invoice total.

The following request updates the paymentMethod, an object, for a bulk invoice:

Command

PATCH /claim/v1/bulk-invoices/xc:SdLxd3WOhsS0mT2Vi1XEu

Request

{
    "data": {
        "attributes": {
            "paymentMethod": {
                "code": "check"
            }
        }
    }
}

When the request is successful, the API responds with the updated bulk invoice and its new payment method.