Skip to main content
POST
/
invoice
/
attachment
/
upload
cURL
curl --request POST \
  --url https://api.valyx.com/invoice/attachment/upload \
  --header 'Content-Type: application/json' \
  --header 'X-Valyx-Attachment-Upload-Signature: <x-valyx-attachment-upload-signature>' \
  --data '
{
  "invoiceNumber": "<string>",
  "attachmentUrl": "<string>",
  "purpose": "INVOICE_FOR_BUYER"
}
'
{
  "error": "<string>",
  "message": "<string>",
  "data": {
    "invoiceId": "<string>",
    "invoiceNumber": "<string>",
    "customerName": "<string>",
    "buyerId": "<string>",
    "attachments": [
      {
        "filename": "<string>",
        "purpose": "<string>",
        "createdAt": "<string>"
      }
    ]
  }
}

Headers

X-Valyx-Attachment-Upload-Signature
string
required

Auth key for attachment upload

X-Fields
string<mask>

An optional fields mask

Body

application/json
invoiceNumber
string
attachmentUrl
string
purpose
enum<string>
Available options:
INVOICE_FOR_BUYER,
INVOICE_SUPPORTING,
PURCHASE_ORDER,
SALES_ORDER,
DELIVERY_DOCUMENT,
PAYMENT_PROOF,
DISPUTE,
DISPUTE_RESOLUTION,
ENQUIRY,
ENQUIRY_RESOLUTION,
TAX_DOCUMENT,
COMMERCIAL_AGREEMENT,
COMMERCIAL_AGREEMENT_SUPPORTING,
LEGAL,
GENERAL,
CREDITNOTE_FOR_BUYER,
CREDITNOTE_SUPPORTING,
TICKET,
USAGE_ESTIMATE,
MAIL_ATTACHMENT

Response

200 - application/json

Success

error
string
message
string
data
object