Credit Notes

Request a credit note document upload

Creates a pending credit note document and returns a presigned upload request. Upload the document with every returned upload_headers entry, including Content-Type (the requested filetype), then use document_id as merchant_credit_note_document_id when creating the credit note after validation succeeds.

post/credit-notes/documents

Request

Request body

filenamestring required

Original filename. The extension must match filetype.

filetype'application/pdf' | 'image/png' | 'image/jpeg' | 'image/jpg' required

MIME type of the credit note document.

Example request

{
  "filename": "credit-note.pdf",
  "filetype": "application/pdf"
}

Response

Pending credit note document upload request.

idstring required
document_idstring required

Use as merchant_credit_note_document_id after validation succeeds.

urlstring uri required
upload_urlstring uri required
upload_expires_atstring date-time required
object_keystring required
transfer_method'presigned_upload' required
upload_headersobject required
validation_profile'merchant_credit_note_document_default' required

Changes

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