PIpiriod
Billing

Upload supporting document

post/supporting-documents/documents/

Request

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

Whether to operate against test-mode data. Defaults to false.

Request body multipart/form-data

idinteger
customerstring required

Customer ID.

document_type'801' | '802' required

801 = Purchase Order. 802 = Contract.

serialstring required
descriptionstring nullable
date_issuedstring date required
valid_untilstring date required
filestring binary required

PDF/image file uploaded as multipart on create.

subscriptionsstring[]
submission_requestinteger nullable

Linked submission request (when delivered as response to one).

usedboolean
status'active' | 'consumed' | 'expired' | 'archived'
createdstring date-time
updatedstring date-time

Response

Document uploaded.

idinteger
customerstring required

Customer ID.

document_type'801' | '802' required

801 = Purchase Order. 802 = Contract.

serialstring required
descriptionstring nullable
date_issuedstring date required
valid_untilstring date required
filestring binary required

PDF/image file uploaded as multipart on create.

subscriptionsstring[]
submission_requestinteger nullable

Linked submission request (when delivered as response to one).

usedboolean
status'active' | 'consumed' | 'expired' | 'archived'
createdstring date-time
updatedstring date-time

Changes

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