Skip to main content
PUT
Error

Authorizations

x-api-key
string
header
required

unique identifier access key. each brand has it own unique key.

Path Parameters

installmentId
string
required

Body

multipart/form-data

maximum file size is 10 MiB: above that the request is rejected with 400 attachmentTooLarge, and above 20 MiB with 413

url
string | null

attachment url, omit when sending a file. maximum size is 10 MiB: above that the request is rejected with 400 attachmentTooLarge

Example:

"https://example.com/attachment"

file
file

binary file, omit when sending a url. maximum size is 10 MiB: above that the request is rejected with 400 attachmentTooLarge, and above 20 MiB with 413

Response

links a PDF to an accounts receivable installment via url or binary file

message
required