Get contract documents

GET

partner

customers

{customerNumber}

contracts

{contractNumber}

documents

Get contract documents

curl --request GET \
  --url https://api.rabot-charge.de/partner/v1/customers/{customerNumber}/contracts/{contractNumber}/documents \
  --header 'Authorization: Bearer <token>'

{
  "isSuccess": true,
  "message": null,
  "error": [
    {
      "severity": "Error",
      "code": "validation-failed",
      "message": "First name is required for non-business customers.",
      "details": null
    }
  ],
  "refUri": "<string>",
  "data": [
    {
      "items": [
        {
          "fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "documentType": "SETTLEMENT",
          "name": "test_filename",
          "extension": ".pdf",
          "sizeInBytes": 123,
          "isAvailableForCustomer": true,
          "lastDownloadedAt": "2024-02-01",
          "info": "<unknown>",
          "billogramUrl": "https://billogram.com/x/123TEST/TEST123"
        }
      ]
    }
  ],
  "count": 10,
  "hasMoreItems": true
}

You can use this API endpoint to retrieve the list of documents related to a particular contract. This includes pre-payment and settlement invoices. Use download documents to download a single document.

Requires role:application scope or Linked relation on customer level.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerNumber

string

required

Customer number

contractNumber

string

required

Contract number

Query Parameters

documentType

enum<string>

default:All

Document type. Default is ALL

Members:

Available options:

All,

PrePayment,

Settlement,

ContractConfirmation

Response

200 - application/json

API response DTO with a list of items.

isSuccess

boolean

Success status of the operation based on status code (2xx range).

Example:

true

message

string | null

Optional message to provide additional information about the operation result.

Example:

null

error

object[] | null

Optional error details in case of an error(s).

Hide child attributes

error.severity

enum<string>

Severity of the error.

Available options:

Error,

Warning,

Notice

Example:

"Error"

error.code

string

Internal error code for client processing.

Example:

"validation-failed"

error.message

string

Error message.

Example:

"First name is required for non-business customers."

error.details

string | null

Additional details about the error.

Example:

null

refUri

string<uri> | null

Optional reference URI to point to the resulting resource.

data

object[]

Returned data instance.

Hide child attributes

data.items

object[]

The list of document DTOs retrieved.

Hide child attributes

data.items.fileId

string<uuid>

File Id

data.items.documentType

enum<string>

Document type

Available options:

All,

PrePayment,

Settlement,

ContractConfirmation

Example:

"SETTLEMENT"

data.items.name

string

File name

Example:

"test_filename"

data.items.extension

string

File extension

Example:

".pdf"

data.items.sizeInBytes

integer<int32>

File size in bytes

data.items.isAvailableForCustomer

boolean

Is file available for customer flag

Example:

true

data.items.lastDownloadedAt

string<date> | null

Last downloaded at (date)

Example:

"2024-02-01"

data.items.info

any | null

File information

data.items.billogramUrl

string | null

Billogram URL

Example:

"https://billogram.com/x/123TEST/TEST123"

count

integer<int32>

Number of items returned in the list.

Example:

10

hasMoreItems

boolean

Indicates, whether there are more items to be returned in the list, that are not included in the limit of this request.

Example:

true

Download documentDownload a single document related to a given contract

⌘I

Get contract documents

curl --request GET \
  --url https://api.rabot-charge.de/partner/v1/customers/{customerNumber}/contracts/{contractNumber}/documents \
  --header 'Authorization: Bearer <token>'

{
  "isSuccess": true,
  "message": null,
  "error": [
    {
      "severity": "Error",
      "code": "validation-failed",
      "message": "First name is required for non-business customers.",
      "details": null
    }
  ],
  "refUri": "<string>",
  "data": [
    {
      "items": [
        {
          "fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "documentType": "SETTLEMENT",
          "name": "test_filename",
          "extension": ".pdf",
          "sizeInBytes": 123,
          "isAvailableForCustomer": true,
          "lastDownloadedAt": "2024-02-01",
          "info": "<unknown>",
          "billogramUrl": "https://billogram.com/x/123TEST/TEST123"
        }
      ]
    }
  ],
  "count": 10,
  "hasMoreItems": true
}

Introduction

Get Started

Quickstart

Guides

Updates

API reference

Authorizations

Path Parameters

Query Parameters

Response