Files
sendico/interface/api/payments/documents_act.yaml
2026-03-02 23:48:59 +01:00

56 lines
1.7 KiB
YAML

get:
tags: [Payments]
summary: Download act document by payment reference
description: Returns the billing act document as binary content.
operationId: paymentsGetActDocument
security:
- bearerAuth: []
parameters:
- $ref: ../parameters/organizations_ref.yaml#/components/parameters/OrganizationsRef
- name: payment_ref
in: query
required: false
description: Payment reference for which to fetch the act document.
schema:
type: string
- name: paymentRef
in: query
required: false
description: Alias of `payment_ref`.
schema:
type: string
responses:
'200':
description: Act document file
content:
application/pdf:
schema:
type: string
format: binary
application/octet-stream:
schema:
type: string
format: binary
'400':
$ref: ../response/operation.yaml#/components/responses/BadRequest
'401':
$ref: ../response/operation.yaml#/components/responses/Unauthorized
'403':
$ref: ../response/operation.yaml#/components/responses/Forbidden
'404':
$ref: ../response/operation.yaml#/components/responses/NotFound
'412':
description: Precondition failed
content:
application/json:
schema:
$ref: ../response/response.yaml#/components/schemas/ErrorResponse
'500':
$ref: ../response/operation.yaml#/components/responses/InternalServerError
'503':
description: Upstream service unavailable
content:
application/json:
schema:
$ref: ../response/response.yaml#/components/schemas/ErrorResponse