InvoiceHeader

Void an approved invoice

Void an approved invoice

put/invoices/{id}/void

Request

Path parameters

idinteger required

Query parameters

return_object'limited' | 'shallow' | 'none'
filterstring

Request body

advance-payment-received-amountnumber

Amount of advance payment received

amount-duenumber

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discountnumber

Amount due after applying the discount

amount-of-advance-paymentnumber

Amount Of Advance Payment

archive-entity-idinteger

Archive Entity Id

canceledboolean

Indicates if transaction has been canceled

cash-accounting-scheme-referencestring string(255)

Note if using cash accounting scheme

cash-register-operatorstring string(255)

Cash Register Operator

clearance-documentstring string

Clearance document attachment file name. Accessible via /retrieve_clearance_document

commentsstring string(255)

comments

compliantboolean

Invoice compliance indicator

confirmationstring string(255)

Confirmation

content-validationboolean

Invoice Content Validation Indicator

correct-value-of-supplynumber

Correct Value of Supply

coupa-accelerate-status'accelerated' string(40)

Status indicating whether the invoice has discount payment terms via Static Discounting

created-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

credit-note-differences-with-original-invoicenumber

Credit Note Differences With Original Invoice

credit-reasonstring string(255)

The reason of creating the credit

customer-accounting-taxnumber

Customer accounting tax

customer-accounting-tax-less-discountnumber

Customer accounting tax after applying the discount

customs-declaration-datestring datetime

Customs Declaration Date

customs-declaration-numberstring string(60)

Customs Declaration Number

customs-officestring text

Customs Office

date-of-discovery-of-facts-decisive-for-correctionstring datetime

Date of Discovery of Facts Decisive for Correction

date-receivedstring datetime

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-datestring datetime

Date of Supply

delivery-numberstring string(255)

Delivery Number

discount-amountnumber

Discount Amount provided by supplier

discount-due-datestring datetime

Discount Due Date calculated based on the discount payment terms

discount-percentnumber float

Discount %

dispute-methodstring string(10)

Dispute Method

document-typestring string

Invoice or Credit Note

early-payment-provisionsstring string(255)

Early payment incentives (This field has been deprecated)

endorsement-on-invoicesstring string(255)

Endorsement On Invoices

exchange-ratenumber

Exchange Rate

exportedboolean

Indicates if transaction has been exported

folio-numberstring string(20)

Folio Number

form-of-paymentstring string(10)

Payment Form

gross-totalnumber

Gross Total

gross-total-less-discountnumber

Invoice total after applying the discount

handling-amountnumber

Handling amount

idinteger

Coupa unique identifier

image-scanstring string(255)

Invoice Image Scan attachment filename

image-scan-urlstring string(255)

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

inbox-namestring string

Inbox Name

internal-notestring text

Internal Note

invoice-datestring datetime required

Date of Invoice

invoice-issuance-timestring string(255)

Invoice Issuance Time

invoice-numberstring string(40) required

Invoice number

invoice-reference-numberstring string(255)

Invoice Reference Number (IRN)

is-credit-noteboolean

Document Type Credit Note

issuance-placestring string(255)

Issuance Place

last-exported-atstring datetime

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penaltiesstring string(255)

Late Payment Penalties

line-level-taxationboolean required

Flag indicating whether taxes are provided at line level in this invoice

lock-version-keyinteger

Lock Version

margin-schemestring string(255)

Reason for using margin scheme

means-of-paymentstring string(255)

Means Of Payment

misc-amountnumber

Miscellaneous Amount

net-due-datestring datetime

Net Due Date calculated based on the net payment terms

net-total-less-discountnumber

Net total after applying the discount

new-means-of-transportstring string(255)

New Means Of Transport

origin-currency-grossnumber required

Local Currency Gross

origin-currency-netnumber required

Local Currency Net

original-invoice-datestring datetime required

Original invoice date used in case of a Credit Note

original-invoice-numberstring string(40) required

Original invoice number used in case of a Credit Note

original-value-of-supplynumber

Original Value of Supply

paidboolean

Paid

payment-channelstring string(40)

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-datestring datetime

Date of payment for invoice

payment-methodstring string(10)

Payment Method

payment-notesstring text

Notes included with payment for invoice

payment-order-referencestring string(255)

Payment Order Reference

place-of-issuancestring string(255)

Place Of Issuance

place-of-supplystring string(255)

Place Of Supply

pre-payment-datestring datetime

Pre-Payment Date

requester-emailstring string

Requester Email

requester-lookup-namestring string

Requester Lookup Name

requester-namestring string

Requester Fullname

reverse-charge-referencestring string(255)

Reverse Charge Reference

security-code-of-issuerstring string(255)

Security Code Of Issuer

self-billing-referencestring string(191)

Self billing reference on the invoice

sender-emailstring string

Sender Email

seriesstring string(30)

Series

shipping-amountnumber

Shipping Amount

show-tax-informationboolean

Show tax information in the invoice

signed-qr-codestring text

Signed QR Code

split-payment-mechanismboolean

Split Payment Mechanism

statusstring string(50)

Invoice Status

supplier-createdstring true

Supplier created indicator for invoice

supplier-invoice-issuer-namestring string(255)

Supplier Invoice Issuer Name

supplier-invoice-reviewer-namestring string(255)

Supplier Invoice Reviewer Name

supplier-notestring text

Note provided by supplier

supplier-payment-collector-namestring string(255)

Supplier Payment Collector Name

supplier-totalnumber

Supplier Total

tax-amountnumber

Tax amount (not used if tax is provided at line level)

tax-amount-enginenumber

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

tax-codestring string(255)

Tax code (not used if tax is provided at line level)

tax-code-enginestring string

Tax code returned by External Tax Engine based on configuration

tax-due-to-suppliernumber

Tax due to the supplier

tax-ratenumber float

Tax rate (not used if tax is provided at line level)

tax-rate-enginenumber

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currencynumber required

Local Currency Tax

tolerance-failuresstring string(512)

Tolerance Failure

total-taxes-less-discountnumber

Total taxes after applying the discount

total-with-taxesnumber

Total with taxes

transaction-notification-datestring datetime

Transaction Notification Date

transaction-uuidstring string(50)

Transaction UUID

type-of-receiptstring string(10)

Type of Receipt

type-of-relationshipstring string(10)

Type of Relationship

unique-identification-code-of-cash-receiptstring string(255)

Unique Identification Code Of Cash Receipt

updated-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

use-of-invoicestring string(10)

Use of the Invoice

withholding-tax-overridenumber

Withholding Tax Override

Response

InvoiceHeader object

advance-payment-received-amountnumber

Amount of advance payment received

amount-duenumber

Amount due to the supplier - Invoice Total without withholding and customer accounting taxes

amount-due-less-discountnumber

Amount due after applying the discount

amount-of-advance-paymentnumber

Amount Of Advance Payment

archive-entity-idinteger

Archive Entity Id

canceledboolean

Indicates if transaction has been canceled

cash-accounting-scheme-referencestring string(255)

Note if using cash accounting scheme

cash-register-operatorstring string(255)

Cash Register Operator

clearance-documentstring string

Clearance document attachment file name. Accessible via /retrieve_clearance_document

commentsstring string(255)

comments

compliantboolean

Invoice compliance indicator

confirmationstring string(255)

Confirmation

content-validationboolean

Invoice Content Validation Indicator

correct-value-of-supplynumber

Correct Value of Supply

coupa-accelerate-status'accelerated' string(40)

Status indicating whether the invoice has discount payment terms via Static Discounting

created-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

credit-note-differences-with-original-invoicenumber

Credit Note Differences With Original Invoice

credit-reasonstring string(255)

The reason of creating the credit

customer-accounting-taxnumber

Customer accounting tax

customer-accounting-tax-less-discountnumber

Customer accounting tax after applying the discount

customs-declaration-datestring datetime

Customs Declaration Date

customs-declaration-numberstring string(60)

Customs Declaration Number

customs-officestring text

Customs Office

date-of-discovery-of-facts-decisive-for-correctionstring datetime

Date of Discovery of Facts Decisive for Correction

date-receivedstring datetime

Date Received in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

delivery-datestring datetime

Date of Supply

delivery-numberstring string(255)

Delivery Number

discount-amountnumber

Discount Amount provided by supplier

discount-due-datestring datetime

Discount Due Date calculated based on the discount payment terms

discount-percentnumber float

Discount %

dispute-methodstring string(10)

Dispute Method

document-typestring string

Invoice or Credit Note

early-payment-provisionsstring string(255)

Early payment incentives (This field has been deprecated)

endorsement-on-invoicesstring string(255)

Endorsement On Invoices

exchange-ratenumber

Exchange Rate

exportedboolean

Indicates if transaction has been exported

folio-numberstring string(20)

Folio Number

form-of-paymentstring string(10)

Payment Form

gross-totalnumber

Gross Total

gross-total-less-discountnumber

Invoice total after applying the discount

handling-amountnumber

Handling amount

idinteger

Coupa unique identifier

image-scanstring string(255)

Invoice Image Scan attachment filename

image-scan-urlstring string(255)

Invoice Image Scan URL. Must begin with 'http://' or 'https://'.

inbox-namestring string

Inbox Name

internal-notestring text

Internal Note

invoice-datestring datetime required

Date of Invoice

invoice-issuance-timestring string(255)

Invoice Issuance Time

invoice-numberstring string(40) required

Invoice number

invoice-reference-numberstring string(255)

Invoice Reference Number (IRN)

is-credit-noteboolean

Document Type Credit Note

issuance-placestring string(255)

Issuance Place

last-exported-atstring datetime

Date and time transaction was last exported in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

late-payment-penaltiesstring string(255)

Late Payment Penalties

line-level-taxationboolean required

Flag indicating whether taxes are provided at line level in this invoice

lock-version-keyinteger

Lock Version

margin-schemestring string(255)

Reason for using margin scheme

means-of-paymentstring string(255)

Means Of Payment

misc-amountnumber

Miscellaneous Amount

net-due-datestring datetime

Net Due Date calculated based on the net payment terms

net-total-less-discountnumber

Net total after applying the discount

new-means-of-transportstring string(255)

New Means Of Transport

origin-currency-grossnumber required

Local Currency Gross

origin-currency-netnumber required

Local Currency Net

original-invoice-datestring datetime required

Original invoice date used in case of a Credit Note

original-invoice-numberstring string(40) required

Original invoice number used in case of a Credit Note

original-value-of-supplynumber

Original Value of Supply

paidboolean

Paid

payment-channelstring string(40)

How the invoice payment will be handled - ERP (default), Coupa Pay Virtual Card, Coupa Pay Invoice Payment

payment-datestring datetime

Date of payment for invoice

payment-methodstring string(10)

Payment Method

payment-notesstring text

Notes included with payment for invoice

payment-order-referencestring string(255)

Payment Order Reference

place-of-issuancestring string(255)

Place Of Issuance

place-of-supplystring string(255)

Place Of Supply

pre-payment-datestring datetime

Pre-Payment Date

requester-emailstring string

Requester Email

requester-lookup-namestring string

Requester Lookup Name

requester-namestring string

Requester Fullname

reverse-charge-referencestring string(255)

Reverse Charge Reference

security-code-of-issuerstring string(255)

Security Code Of Issuer

self-billing-referencestring string(191)

Self billing reference on the invoice

sender-emailstring string

Sender Email

seriesstring string(30)

Series

shipping-amountnumber

Shipping Amount

show-tax-informationboolean

Show tax information in the invoice

signed-qr-codestring text

Signed QR Code

split-payment-mechanismboolean

Split Payment Mechanism

statusstring string(50)

Invoice Status

supplier-createdstring true

Supplier created indicator for invoice

supplier-invoice-issuer-namestring string(255)

Supplier Invoice Issuer Name

supplier-invoice-reviewer-namestring string(255)

Supplier Invoice Reviewer Name

supplier-notestring text

Note provided by supplier

supplier-payment-collector-namestring string(255)

Supplier Payment Collector Name

supplier-totalnumber

Supplier Total

tax-amountnumber

Tax amount (not used if tax is provided at line level)

tax-amount-enginenumber

Tax amount calculated by either Coupa Native or External Tax Engine based on configuration

tax-codestring string(255)

Tax code (not used if tax is provided at line level)

tax-code-enginestring string

Tax code returned by External Tax Engine based on configuration

tax-due-to-suppliernumber

Tax due to the supplier

tax-ratenumber float

Tax rate (not used if tax is provided at line level)

tax-rate-enginenumber

Tax rate returned by External Tax Engine based on configuration

taxes-in-origin-country-currencynumber required

Local Currency Tax

tolerance-failuresstring string(512)

Tolerance Failure

total-taxes-less-discountnumber

Total taxes after applying the discount

total-with-taxesnumber

Total with taxes

transaction-notification-datestring datetime

Transaction Notification Date

transaction-uuidstring string(50)

Transaction UUID

type-of-receiptstring string(10)

Type of Receipt

type-of-relationshipstring string(10)

Type of Relationship

unique-identification-code-of-cash-receiptstring string(255)

Unique Identification Code Of Cash Receipt

updated-atstring datetime

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

use-of-invoicestring string(10)

Use of the Invoice

withholding-tax-overridenumber

Withholding Tax Override

Changes

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