We're delighted to present you with the comprehensive API documentation for PEAX. This all-in-one workspace for API design offers you a clear, concise, and interactive exploration of our API functionalities.
- Introduction
- General
- Input API
- Scanning API
- Document API
- Overview
- Webhook API
- Changelog
- EndPoints
- Create LinkingPOST
- Retrieve document metadata informationPOST
- Get content of a documentGET
- Query for documents and their last updated timestampGET
- Confirm a document has been retrieved (v2)PATCH
- Confirm a document has been retrieved (v1)PATCH
- Request Original OrderPOST
- Send external metadataPOST
- Upload the XML DocumentPOST
- Get content of XML DocumentGET
- Account API
Retrieve document metadata information
POST
https://proxy-stage.peax.ch/document-partner-service/agent-api/v1/sources/{sourceId}/accounts/{accountPeaxId}/documents/metadata
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Path Params
Header Params
Body Params application/json
Example
{
"documentIds": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://proxy-stage.peax.ch/document-partner-service/agent-api/v1/sources//accounts//documents/metadata' \
--header 'Authorization: Bearer {{JWT}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"documentIds": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}'Responses
🟢200Operation successful
application/json
Body
Example
{
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"title": "string",
"type": "DOCUMENT",
"status": "NONE",
"distributionState": "ASSIGNMENT_NOT_INITIATED",
"number": "string",
"language": "EN",
"documentDate": "2019-08-24",
"receivedAt": "2019-08-24T14:15:22Z",
"originalOrderDetails": {
"orderableUntil": "2019-08-24T14:15:22Z",
"orderedAt": "2019-08-24T14:15:22Z"
},
"physicallyForwardedAt": "2019-08-24T14:15:22Z",
"additionalComment": "string",
"customerNumber": "string",
"contractNumber": "string",
"amount": {
"value": 0,
"currency": {}
},
"amountExcludedVat": {
"value": 0,
"currency": {}
},
"invoiceNumber": "string",
"periodFrom": "2019-08-24",
"periodTo": "2019-08-24",
"month": 0,
"year": 0,
"socialSecurityNumber": "string",
"sender": {
"name": "string",
"address": {
"addressSupplement": "string",
"street": "string",
"poBox": "string",
"streetNumber": "string",
"postalCode": "string",
"city": "string",
"country": "string"
}
},
"receiver": {
"name": "string",
"address": {
"addressSupplement": "string",
"street": "string",
"poBox": "string",
"streetNumber": "string",
"postalCode": "string",
"city": "string",
"country": "string"
}
},
"channel": "string",
"paymentDetails": {
"paymentType": "ORANGE_PAYMENT_SLIP",
"status": "OPEN",
"paymentMethod": "TRANSACTION_ACCOUNT",
"recordType": "NONE",
"creditor": {
"legalEntity": {
"name": "string",
"address": {
"addressSupplement": "string",
"street": "string",
"poBox": "string",
"streetNumber": "string",
"postalCode": "string",
"city": "string",
"country": "string"
}
},
"iban": "string"
},
"debtor": {
"legalEntity": {
"name": "string",
"address": {
"addressSupplement": "string",
"street": "string",
"poBox": "string",
"streetNumber": "string",
"postalCode": "string",
"city": "string",
"country": "string"
}
},
"iban": "string"
},
"ultimateDebtor": {
"legalEntity": {
"name": "string",
"address": {
"addressSupplement": "string",
"street": "string",
"poBox": "string",
"streetNumber": "string",
"postalCode": "string",
"city": "string",
"country": "string"
}
},
"iban": "string"
},
"dueDate": "2019-08-24",
"referenceNumber": "string",
"paidDate": "2019-08-24",
"settlementDate": "2019-08-24",
"respiteDays": 0,
"scor": "string",
"remittanceInfoAdditional": "string",
"remittanceInfoUnstructured": "string"
},
"taxDetails": {
"capitalAmount": {
"value": 0,
"currency": {}
},
"interestAmount": {
"value": 0,
"currency": {}
},
"withholdingAmount": {
"value": 0,
"currency": {}
}
},
"vatDetails": {
"uid": "string",
"vat": "string",
"vatTransactionStartDate": "2019-08-24",
"vatTransactionEndDate": "2019-08-24",
"vat1Percentage": 0,
"vat1ImportTaxAmount": {
"value": 0,
"currency": {}
},
"vat2Percentage": 0,
"vat2ImportTaxAmount": {
"value": 0,
"currency": {}
},
"vat3Percentage": 0,
"vat3ImportTaxAmount": {
"value": 0,
"currency": {}
}
},
"tags": [
{
"color": "string",
"name": "string"
}
]
}🟢204No content
🟠400Bad request
🟠403Permission denied
🟠404Not found
🔴500Internal server error
Modified at 2024-07-24 18:19:24