Get Payable

Request Information
URL GET {{basepath}}/api/:project/payable/:payable-id
CategoryPayable

Description

Returns the payable if it exists

Returns a PayableGetResponse

Url variables
:project{{project}}
:payable-id{{payable_id}}
Header
Content-Typeapplication/json

Example responses

Get Payable
Request Method & URL
GET {{basepath}}/api/:project/payable/:payable-id
Url variables
:project{{project}}
:payable-id{{payable_id}}
Response Code:
200 OK
Response Body:
{
    "responseId": "2_a3c4dec2d216f113ee81f049d58a471d6d4fd232",
    "message": "The payable is attached",
    "payable": {
        "identifier": "1_2_e4a857a90c92a8b9d24bca61f74cb01c46697e951637851867",
        "status": "closed",
        "to": {
            "user@example.com": "Test User"
        },
        "referenceId": "MD-2021-10-4-15-51-7",
        "process": "3",
        "run": "none",
        "crmId": "crm-23",
        "currency": "EUR",
        "initialValue": 20.6,
        "remainingValue": 20.6,
        "paymentPeriod": 30,
        "dunningPeriod": 21,
        "created": 1637851867,
        "modified": 1637851867,
        "parameters": {
            "locale": "nl",
            "domain": "mijndomein.nl",
            "firstname": "Test",
            "lastname": "User",
            "invoiceid": "MD-2021-10-4-15-51-7",
            "street": "Zuidelijk Halfrond",
            "housenumber": "1",
            "postalcode": "2801DD",
            "city": "Gouda",
            "state": "Zuid holland",
            "country": "NL",
            "phone": "+31.000000001",
            "cellphone": "+31.000000001",
            "bankaccount": "555",
            "companyName": "",
            "email": "user@example.com",
            "invoice_pdf": "http:\/\/ds.metaregistrar.work\/pr\/documents\/invoices\/1\/MTR-000029998.pdf",
            "paybydate": 1640443867,
            "dunningfinaldate": 1642258267,
            "kickoff": 1637851867,
            "downloadCode": "6b6cf18179668d1d385acb582aa0bd503ba55c81"
        }
    }
}
Payable that does not exist
Request Method & URL
GET {{basepath}}/api/:project/payable/:payable-id
Url variables
:project{{project}}
:payable-id{{payable_id}}_nope
Response Code:
404 Not Found
Response Body:
{
    "responseId": "2_4604e4d6655a6a7428e2d31674ecc1458f0c5167",
    "status": "error",
    "errorCode": "not_found",
    "errorMessage": "No such payable"
}