Get income document

Credentials

No credentials are documented for this endpoint.

Retrieve a specific income document by ID.

Parameters

Name In Type Required Description
id path string yes Document ID

Code samples

curl

curl -X GET 'https://sandbox.payme.io/api/seller/api/documents/income/<id>'

Node.js

const response = await fetch("https://sandbox.payme.io/api/seller/api/documents/income/<id>", {
  method: "GET",
});

console.log(await response.text());

Python

import requests

response = requests.get(
    "https://sandbox.payme.io/api/seller/api/documents/income/<id>",
)

print(response.text)

PHP

<?php

$ch = curl_init('https://sandbox.payme.io/api/seller/api/documents/income/<id>');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Responses

200 — Successful response (success)

Field Type Description
id string
docType string
docNumber string Document number
docRegulationNumber string Tax authority regulation number
valueDate string
dueDate string
client object
client.name string Client/customer name
client.email string Client email address
client.phone string Client phone number
client.socialId string Client's social/business ID number (ת.ז. / ח.פ.)
totalWithoutVat number
vatAmount number
totalAmount number
currency string
status string
url string Document download URL
createdAt string

401 — Unauthorized (error)

Field Type Description
statusCode integer HTTP status code
message string Error message(s)
error string Error type 
{
  "statusCode": 401,
  "message": "Unauthorized",
  "error": "Unauthorized"
}

404 — Not Found (error)

Field Type Description
statusCode integer HTTP status code
message string Error message(s)
error string Error type 
{
  "statusCode": 404,
  "message": "Document not found",
  "error": "Not Found"
}