Mark payable as paid

curl --request POST \
  --url https://api.sandbox.tesouro.com/finops/v1/payables/{payable_id}/mark-as-paid \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-finops-version: <x-finops-version>' \
  --header 'x-organization-id: <x-organization-id>' \
  --data '
{
  "comment": "<string>",
  "is_external": true,
  "paid_at": "2023-11-07T05:31:56Z",
  "payment_intent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_method": "<string>",
  "payment_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.sandbox.tesouro.com/finops/v1/payables/{payable_id}/mark-as-paid"

payload = {
    "comment": "<string>",
    "is_external": True,
    "paid_at": "2023-11-07T05:31:56Z",
    "payment_intent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payment_method": "<string>",
    "payment_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "x-finops-version": "<x-finops-version>",
    "x-organization-id": "<x-organization-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-finops-version': '<x-finops-version>',
    'x-organization-id': '<x-organization-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    comment: '<string>',
    is_external: true,
    paid_at: '2023-11-07T05:31:56Z',
    payment_intent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    payment_method: '<string>',
    payment_record_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.sandbox.tesouro.com/finops/v1/payables/{payable_id}/mark-as-paid', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.tesouro.com/finops/v1/payables/{payable_id}/mark-as-paid",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'comment' => '<string>',
    'is_external' => true,
    'paid_at' => '2023-11-07T05:31:56Z',
    'payment_intent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'payment_method' => '<string>',
    'payment_record_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-finops-version: <x-finops-version>",
    "x-organization-id: <x-organization-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.tesouro.com/finops/v1/payables/{payable_id}/mark-as-paid"

	payload := strings.NewReader("{\n  \"comment\": \"<string>\",\n  \"is_external\": true,\n  \"paid_at\": \"2023-11-07T05:31:56Z\",\n  \"payment_intent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"payment_method\": \"<string>\",\n  \"payment_record_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-finops-version", "<x-finops-version>")
	req.Header.Add("x-organization-id", "<x-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.tesouro.com/finops/v1/payables/{payable_id}/mark-as-paid")
  .header("x-finops-version", "<x-finops-version>")
  .header("x-organization-id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"comment\": \"<string>\",\n  \"is_external\": true,\n  \"paid_at\": \"2023-11-07T05:31:56Z\",\n  \"payment_intent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"payment_method\": \"<string>\",\n  \"payment_record_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.tesouro.com/finops/v1/payables/{payable_id}/mark-as-paid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-finops-version"] = '<x-finops-version>'
request["x-organization-id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"comment\": \"<string>\",\n  \"is_external\": true,\n  \"paid_at\": \"2023-11-07T05:31:56Z\",\n  \"payment_intent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"payment_method\": \"<string>\",\n  \"payment_record_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "8940c6f2-0614-4284-8260-64c8fe1c820d",
  "created_at": "2023-06-01T09:15:00+00:00",
  "updated_at": "2024-01-16T09:15:00+00:00",
  "credit_notes": [
    {
      "document_id": "CN-123456",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "issued_at": "2024-01-15",
      "status": "submitted_for_approval",
      "total_amount": 1000
    }
  ],
  "entity_id": "31c5d948-45a9-410d-b663-e6c5bff208d0",
  "payable_origin": "upload",
  "source_of_payable_data": "ocr",
  "status": "paid",
  "amount_due": 0,
  "amount_paid": 1350,
  "amount_to_pay": 0,
  "approval_policy_id": "acca576b-8592-43dd-8640-4f666833bf8d",
  "counterpart": {
    "email": "acme@example.com",
    "name": "Acme Inc.",
    "phone": "5551231234",
    "tax_id": "123456789"
  },
  "counterpart_address_id": "8ecb94a4-d4f3-46a2-ad52-d873810d78a6",
  "counterpart_bank_account_id": "dc626f45-e9f7-4c97-a1cd-1de279c934c6",
  "counterpart_id": "20efb53b-c3ef-4f55-977f-9a0ad6453b43",
  "counterpart_raw_data": {
    "email": "acme@example.com",
    "name": "Acme Inc.",
    "phone": "5551231234",
    "tax_id": "123456789"
  },
  "counterpart_vat_id_id": "a0b8cf93-6b7f-4ea2-8f09-8d8ac2c5e3f2",
  "currency": "USD",
  "currency_exchange": {
    "default_currency_code": "EUR",
    "rate": 1.08,
    "total": 1458
  },
  "description": "Office supplies for Q3",
  "discount": 150,
  "document_id": "INV-2287",
  "due_date": "2023-07-01",
  "duplicates": [
    {
      "created_at": "2023-06-01T09:15:00+00:00",
      "id": "5e6f7a8b-9c0d-4e1f-8a2b-4c5d6e7f8091",
      "matched_payable_id": "6f7a8b9c-0d1e-4f2a-9b3c-5d6e7f809102",
      "matched_payable_status": "new",
      "resolved_at": "2023-06-02T09:15:00+00:00",
      "resolved_by_user_id": "2ec8f1a3-60ca-48e0-a5f9-a38e683e3bf8",
      "status": "confirmed",
      "updated_at": "2023-06-02T09:15:00+00:00"
    }
  ],
  "enforce_approval_policy_id": "acca576b-8592-43dd-8640-4f666833bf8d",
  "file": {
    "created_at": "2023-06-01T09:15:00+00:00",
    "file_type": "payables",
    "id": "0b78b85c-bb5a-42e2-994b-509abb733def",
    "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
    "mimetype": "application/pdf",
    "name": "invoice.pdf",
    "region": "eu-central-1",
    "size": 24381,
    "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf"
  },
  "file_id": "0b78b85c-bb5a-42e2-994b-509abb733def",
  "issued_at": "2023-06-01",
  "marked_as_paid_by_entity_user_id": "71e8875a-43b3-434f-b12a-54c84c176ef3",
  "marked_as_paid_with_comment": "Was paid partly in the end of the month.",
  "ocr_request_id": "064f8e30-ac0d-4820-a1b5-33398aaafcff",
  "ocr_status": "success",
  "other_extracted_data": {
    "counterpart_name": "Acme Inc.",
    "currency": "USD",
    "document_id": "INV-2287",
    "total_excl_vat_raw": 12.5,
    "total_raw": 13.5
  },
  "paid_at": "2023-06-15T10:32:00+00:00",
  "partner_metadata": {
    "internal_id": "PO-2024-001"
  },
  "payee_account_id": "1d7b5e2a-9c4f-4e3b-8a1d-6f2c3b4a5d6e",
  "payment_terms": {
    "name": "Net 30 with early discount",
    "term_1": {
      "discount": 200,
      "number_of_days": 10
    },
    "term_final": {
      "number_of_days": 30
    }
  },
  "project_id": "d480fc79-1c87-4d45-ae1a-14855e010341",
  "purchase_order_id": "689e9a1f-a357-4e53-8b6c-a2259b56714e",
  "purchase_order_number": "PO-2024-001",
  "scheduled_payment_date": null,
  "sender": "hello@example.com",
  "subtotal": 1250,
  "suggested_payment_term": {
    "date": "2023-06-11",
    "discount": 200
  },
  "tags": [
    {
      "created_at": "2022-09-07T16:35:18.484507+00:00",
      "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
      "name": "Marketing",
      "updated_at": "2022-09-07T16:35:18.484507+00:00"
    }
  ],
  "tax": 2000,
  "tax_amount": 250,
  "total_amount": 1350,
  "total_amount_with_credit_notes": 1350,
  "was_created_by_user_id": "2ec8f1a3-60ca-48e0-a5f9-a38e683e3bf8"
}

{
  "error": {
    "message": "<string>"
  }
}

{
  "error": {
    "message": "<string>"
  }
}

{
  "error": {
    "message": "<string>"
  }
}

{
  "error": {
    "message": "<string>"
  }
}

{
  "error": {
    "message": "<string>"
  }
}

{
  "error": {
    "message": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

{
  "error": {
    "message": "<string>"
  }
}

Payables

Mark payable as paid

Mark a payable as paid.

Payables can be paid using the payment channels offered by Monite or through external payment channels. In the latter case, the invoice is not automatically marked as paid in the system and needs to be converted to the paid status manually.

Optionally, it is possible to pass the comment field in the request body, to describe how and when the invoice was paid.

Notes:

To use this endpoint with an entity user token, this entity user must have a role that includes the pay permission for payables.
The amount_to_pay field is automatically calculated based on the amount_due less the percentage described in the payment_terms.discount value.

Related guide: Mark a payable as paid

See also:

Payables lifecycle

Payables status transitions

POST

payables

{payable_id}

mark-as-paid

Mark payable as paid

curl --request POST \
  --url https://api.sandbox.tesouro.com/finops/v1/payables/{payable_id}/mark-as-paid \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-finops-version: <x-finops-version>' \
  --header 'x-organization-id: <x-organization-id>' \
  --data '
{
  "comment": "<string>",
  "is_external": true,
  "paid_at": "2023-11-07T05:31:56Z",
  "payment_intent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_method": "<string>",
  "payment_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.sandbox.tesouro.com/finops/v1/payables/{payable_id}/mark-as-paid"

payload = {
    "comment": "<string>",
    "is_external": True,
    "paid_at": "2023-11-07T05:31:56Z",
    "payment_intent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payment_method": "<string>",
    "payment_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "x-finops-version": "<x-finops-version>",
    "x-organization-id": "<x-organization-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-finops-version': '<x-finops-version>',
    'x-organization-id': '<x-organization-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    comment: '<string>',
    is_external: true,
    paid_at: '2023-11-07T05:31:56Z',
    payment_intent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    payment_method: '<string>',
    payment_record_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.sandbox.tesouro.com/finops/v1/payables/{payable_id}/mark-as-paid', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.tesouro.com/finops/v1/payables/{payable_id}/mark-as-paid",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'comment' => '<string>',
    'is_external' => true,
    'paid_at' => '2023-11-07T05:31:56Z',
    'payment_intent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'payment_method' => '<string>',
    'payment_record_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-finops-version: <x-finops-version>",
    "x-organization-id: <x-organization-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.tesouro.com/finops/v1/payables/{payable_id}/mark-as-paid"

	payload := strings.NewReader("{\n  \"comment\": \"<string>\",\n  \"is_external\": true,\n  \"paid_at\": \"2023-11-07T05:31:56Z\",\n  \"payment_intent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"payment_method\": \"<string>\",\n  \"payment_record_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-finops-version", "<x-finops-version>")
	req.Header.Add("x-organization-id", "<x-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.tesouro.com/finops/v1/payables/{payable_id}/mark-as-paid")
  .header("x-finops-version", "<x-finops-version>")
  .header("x-organization-id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"comment\": \"<string>\",\n  \"is_external\": true,\n  \"paid_at\": \"2023-11-07T05:31:56Z\",\n  \"payment_intent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"payment_method\": \"<string>\",\n  \"payment_record_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.tesouro.com/finops/v1/payables/{payable_id}/mark-as-paid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-finops-version"] = '<x-finops-version>'
request["x-organization-id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"comment\": \"<string>\",\n  \"is_external\": true,\n  \"paid_at\": \"2023-11-07T05:31:56Z\",\n  \"payment_intent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"payment_method\": \"<string>\",\n  \"payment_record_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "8940c6f2-0614-4284-8260-64c8fe1c820d",
  "created_at": "2023-06-01T09:15:00+00:00",
  "updated_at": "2024-01-16T09:15:00+00:00",
  "credit_notes": [
    {
      "document_id": "CN-123456",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "issued_at": "2024-01-15",
      "status": "submitted_for_approval",
      "total_amount": 1000
    }
  ],
  "entity_id": "31c5d948-45a9-410d-b663-e6c5bff208d0",
  "payable_origin": "upload",
  "source_of_payable_data": "ocr",
  "status": "paid",
  "amount_due": 0,
  "amount_paid": 1350,
  "amount_to_pay": 0,
  "approval_policy_id": "acca576b-8592-43dd-8640-4f666833bf8d",
  "counterpart": {
    "email": "acme@example.com",
    "name": "Acme Inc.",
    "phone": "5551231234",
    "tax_id": "123456789"
  },
  "counterpart_address_id": "8ecb94a4-d4f3-46a2-ad52-d873810d78a6",
  "counterpart_bank_account_id": "dc626f45-e9f7-4c97-a1cd-1de279c934c6",
  "counterpart_id": "20efb53b-c3ef-4f55-977f-9a0ad6453b43",
  "counterpart_raw_data": {
    "email": "acme@example.com",
    "name": "Acme Inc.",
    "phone": "5551231234",
    "tax_id": "123456789"
  },
  "counterpart_vat_id_id": "a0b8cf93-6b7f-4ea2-8f09-8d8ac2c5e3f2",
  "currency": "USD",
  "currency_exchange": {
    "default_currency_code": "EUR",
    "rate": 1.08,
    "total": 1458
  },
  "description": "Office supplies for Q3",
  "discount": 150,
  "document_id": "INV-2287",
  "due_date": "2023-07-01",
  "duplicates": [
    {
      "created_at": "2023-06-01T09:15:00+00:00",
      "id": "5e6f7a8b-9c0d-4e1f-8a2b-4c5d6e7f8091",
      "matched_payable_id": "6f7a8b9c-0d1e-4f2a-9b3c-5d6e7f809102",
      "matched_payable_status": "new",
      "resolved_at": "2023-06-02T09:15:00+00:00",
      "resolved_by_user_id": "2ec8f1a3-60ca-48e0-a5f9-a38e683e3bf8",
      "status": "confirmed",
      "updated_at": "2023-06-02T09:15:00+00:00"
    }
  ],
  "enforce_approval_policy_id": "acca576b-8592-43dd-8640-4f666833bf8d",
  "file": {
    "created_at": "2023-06-01T09:15:00+00:00",
    "file_type": "payables",
    "id": "0b78b85c-bb5a-42e2-994b-509abb733def",
    "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
    "mimetype": "application/pdf",
    "name": "invoice.pdf",
    "region": "eu-central-1",
    "size": 24381,
    "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf"
  },
  "file_id": "0b78b85c-bb5a-42e2-994b-509abb733def",
  "issued_at": "2023-06-01",
  "marked_as_paid_by_entity_user_id": "71e8875a-43b3-434f-b12a-54c84c176ef3",
  "marked_as_paid_with_comment": "Was paid partly in the end of the month.",
  "ocr_request_id": "064f8e30-ac0d-4820-a1b5-33398aaafcff",
  "ocr_status": "success",
  "other_extracted_data": {
    "counterpart_name": "Acme Inc.",
    "currency": "USD",
    "document_id": "INV-2287",
    "total_excl_vat_raw": 12.5,
    "total_raw": 13.5
  },
  "paid_at": "2023-06-15T10:32:00+00:00",
  "partner_metadata": {
    "internal_id": "PO-2024-001"
  },
  "payee_account_id": "1d7b5e2a-9c4f-4e3b-8a1d-6f2c3b4a5d6e",
  "payment_terms": {
    "name": "Net 30 with early discount",
    "term_1": {
      "discount": 200,
      "number_of_days": 10
    },
    "term_final": {
      "number_of_days": 30
    }
  },
  "project_id": "d480fc79-1c87-4d45-ae1a-14855e010341",
  "purchase_order_id": "689e9a1f-a357-4e53-8b6c-a2259b56714e",
  "purchase_order_number": "PO-2024-001",
  "scheduled_payment_date": null,
  "sender": "hello@example.com",
  "subtotal": 1250,
  "suggested_payment_term": {
    "date": "2023-06-11",
    "discount": 200
  },
  "tags": [
    {
      "created_at": "2022-09-07T16:35:18.484507+00:00",
      "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
      "name": "Marketing",
      "updated_at": "2022-09-07T16:35:18.484507+00:00"
    }
  ],
  "tax": 2000,
  "tax_amount": 250,
  "total_amount": 1350,
  "total_amount_with_credit_notes": 1350,
  "was_created_by_user_id": "2ec8f1a3-60ca-48e0-a5f9-a38e683e3bf8"
}

{
  "error": {
    "message": "<string>"
  }
}

{
  "error": {
    "message": "<string>"
  }
}

{
  "error": {
    "message": "<string>"
  }
}

{
  "error": {
    "message": "<string>"
  }
}

{
  "error": {
    "message": "<string>"
  }
}

{
  "error": {
    "message": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

{
  "error": {
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Headers

x-finops-version

string<date>

required

x-organization-id

string<uuid>

required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

payable_id

string<uuid>

required

Body

application/json

comment

string | null

An arbitrary comment that describes how and when this payable was paid.

is_external

boolean | null

Whether the payment was recorded manually rather than processed by us.

paid_at

string<date-time> | null

Date and time when the payment was executed.

payment_intent_id

string<uuid> | null

ID of the payment intent that was paid.

payment_method

string | null

Payment method used for the payment.

payment_record_id

string<uuid> | null

ID of the payment record behind this status change.

Response

Successful Response

Represents an Accounts Payable document received from a vendor or supplier.

string<uuid>

required

A unique ID assigned to this payable.

Example:

"8940c6f2-0614-4284-8260-64c8fe1c820d"

created_at

string<date-time>

required

UTC date and time when this payable was created. Timestamps follow the ISO 8601 format.

Example:

"2023-06-01T09:15:00+00:00"

updated_at

string<date-time>

required

UTC date and time when this payable was last updated. Timestamps follow the ISO 8601 format.

Example:

"2024-01-16T09:15:00+00:00"

credit_notes

object[]

required

The list of linked credit notes of the payable.

Show child attributes

Example:

[
  {
    "document_id": "CN-123456",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "issued_at": "2024-01-15",
    "status": "submitted_for_approval",
    "total_amount": 1000
  }
]

entity_id

string<uuid>

required

The ID of the entity to which the payable was issued.

Example:

"31c5d948-45a9-410d-b663-e6c5bff208d0"

payable_origin

enum<string>

required

Specifies how this payable was created in Monite: upload - created via an API call, email - sent via email to the entity's mailbox.

Available options:

upload,

email

Example:

"upload"

source_of_payable_data

enum<string>

required

Specifies how the property values of this payable were provided: ocr - Monite OCR service extracted the values from the provided PDF or image file, user_specified - values were added or updated via an API call.

Available options:

ocr,

user_specified

Example:

"ocr"

status

enum<string>

required

The status of the payable.

Available options:

draft,

new,

approve_in_progress,

waiting_to_be_paid,

partially_paid,

paid,

canceled,

rejected

Example:

"paid"

amount_due

integer | null

How much is left to be paid on the invoice (in minor units).

Example:

0

amount_paid

integer | null

How much was paid on the invoice (in minor units).

Example:

1350

amount_to_pay

integer | null

How much is left to be paid on the invoice (in minor units) with discounts from payment terms.

Example:

0

approval_policy_id

string<uuid> | null

Id of existing approval policy that applies to this payable, if any. A policy is applied if the payable matches the policy trigger conditions.

Example:

"acca576b-8592-43dd-8640-4f666833bf8d"

counterpart

object | null

Object representing de-normalized counterpart data. Filled at the moment of invoice submitting for approval or payment.

Show child attributes

Example:

{
  "email": "acme@example.com",
  "name": "Acme Inc.",
  "phone": "5551231234",
  "tax_id": "123456789"
}

counterpart_address_id

string<uuid> | null

The ID of counterpart address object stored in counterparts service

Example:

"8ecb94a4-d4f3-46a2-ad52-d873810d78a6"

counterpart_bank_account_id

string<uuid> | null

The ID of counterpart bank account object stored in counterparts service

Example:

"dc626f45-e9f7-4c97-a1cd-1de279c934c6"

counterpart_id

string<uuid> | null

The ID of the counterpart object that represents the vendor or supplier.

Example:

"20efb53b-c3ef-4f55-977f-9a0ad6453b43"

counterpart_raw_data

object | null

Object representing counterpart data which was extracted by OCR. Used for informational purposes.

Show child attributes

Example:

{
  "email": "acme@example.com",
  "name": "Acme Inc.",
  "phone": "5551231234",
  "tax_id": "123456789"
}

counterpart_vat_id_id

string<uuid> | null

The ID of counterpart VAT ID object stored in counterparts service

Example:

"a0b8cf93-6b7f-4ea2-8f09-8d8ac2c5e3f2"

currency

enum<string> | null

The currency code of the currency used in the payable.

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLE,

SOS,

SRD,

SSP,

SVC,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"USD"

currency_exchange

object | null

Show child attributes

Example:

{
  "default_currency_code": "EUR",
  "rate": 1.08,
  "total": 1458
}

description

string | null

An arbitrary description of this payable.

Example:

"Office supplies for Q3"

discount

integer | null

The discount stated on the document. This is informational only: total_amount is expected to already reflect it, and the API never applies or subtracts it separately. in minor units. For example, $12.50 is represented as 1250.

Example:

150

document_id

string | null

A unique invoice number assigned by the invoice issuer for payment tracking purposes. This is different from id which is an internal ID created automatically by Monite.

Example:

"INV-2287"

due_date

string<date> | null

The date by which the payable must be paid, in the YYYY-MM-DD format. If the payable specifies payment terms with early payment discounts, this is the final payment date.

Example:

"2023-07-01"

duplicates

object[]

Suspected and reviewed duplicates of this payable. Both payables of a matched pair see the same match. Ordered: suspected first, then confirmed, then dismissed, newest first within each group. At most 100 entries are returned.

Show child attributes

Example:

[
  {
    "created_at": "2023-06-01T09:15:00+00:00",
    "id": "5e6f7a8b-9c0d-4e1f-8a2b-4c5d6e7f8091",
    "matched_payable_id": "6f7a8b9c-0d1e-4f2a-9b3c-5d6e7f809102",
    "matched_payable_status": "new",
    "resolved_at": "2023-06-02T09:15:00+00:00",
    "resolved_by_user_id": "2ec8f1a3-60ca-48e0-a5f9-a38e683e3bf8",
    "status": "confirmed",
    "updated_at": "2023-06-02T09:15:00+00:00"
  }
]

enforce_approval_policy_id

string<uuid> | null

Id of an existing approval policy that should be enforced when submitting the payable for approval.If this field is set, no other policies will be evaluated via their triggers - the specified policy will always be applied instead.

Example:

"acca576b-8592-43dd-8640-4f666833bf8d"

file

object | null

The original file from which this payable was created.

Show child attributes

Example:

{
  "created_at": "2023-06-01T09:15:00+00:00",
  "file_type": "payables",
  "id": "0b78b85c-bb5a-42e2-994b-509abb733def",
  "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
  "mimetype": "application/pdf",
  "name": "invoice.pdf",
  "region": "eu-central-1",
  "size": 24381,
  "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf"
}

file_id

string<uuid> | null

File id to retrieve the stored file info.

Example:

"0b78b85c-bb5a-42e2-994b-509abb733def"

issued_at

string<date> | null

The date when the payable was issued, in the YYYY-MM-DD format.

Example:

"2023-06-01"

marked_as_paid_by_entity_user_id

string<uuid> | null

The ID of the entity user who marked this document as paid.

Example:

"71e8875a-43b3-434f-b12a-54c84c176ef3"

marked_as_paid_with_comment

string | null

An arbitrary comment that describes how and when this payable was paid.

Example:

"Was paid partly in the end of the month."

ocr_request_id

string<uuid> | null

Id of OCR request to match asynchronous result of processing payable.

Example:

"064f8e30-ac0d-4820-a1b5-33398aaafcff"

ocr_status

enum<string> | null

The status of the data recognition process using OCR. The 'processing' status means that the data recognition is in progress and the user needs to wait for the data enrichment. The 'error' status indicates that some error occurred on the OCR side and the user can fill in the data manually. The 'success' status means the data recognition has been successfully completed, after which the user can check the data if desired and enrich or correct it.

Available options:

processing,

error,

success,

canceled

Example:

"success"

other_extracted_data

object

Data extracted from the uploaded payable by OCR.

Option 1
Option 2

Show child attributes

Example:

{
  "counterpart_name": "Acme Inc.",
  "currency": "USD",
  "document_id": "INV-2287",
  "total_excl_vat_raw": 12.5,
  "total_raw": 13.5
}

paid_at

string<date-time> | null

The date by which the payable was paid

Example:

"2023-06-15T10:32:00+00:00"

partner_metadata

object | null

Metadata for partner needs

Example:

{ "internal_id": "PO-2024-001" }

payee_account_id

string<uuid> | null

The ID of the FIS payee account object stored in the Payments service, used for FIS Bill Pay STP.

Example:

"1d7b5e2a-9c4f-4e3b-8a1d-6f2c3b4a5d6e"

payment_terms

object | null

The number of days to pay with potential discount for options shorter than due_date

Show child attributes

Example:

{
  "name": "Net 30 with early discount",
  "term_1": { "discount": 200, "number_of_days": 10 },
  "term_final": { "number_of_days": 30 }
}

project_id

string<uuid> | null

Project id of a payable.

Example:

"d480fc79-1c87-4d45-ae1a-14855e010341"

purchase_order_id

string<uuid> | null

The identifier of the purchase order to which this payable belongs.

Example:

"689e9a1f-a357-4e53-8b6c-a2259b56714e"

purchase_order_number

string | null

The PO number as it appears on the document - not validated against, or linked to, any purchase order record. See purchase_order_id for that.

Maximum string length: 255

Example:

"PO-2024-001"

scheduled_payment_date

string<date> | null

The date of this payable's earliest live scheduled payment, in the YYYY-MM-DD format, or null if it has none. This is the value sort=scheduled_payment_date orders by; payables with no live scheduled payment sort last in ascending order and first in descending order.

Example:

null

sender

string<email> | null

The email address from which the invoice was sent to the entity.

Example:

"hello@example.com"

subtotal

integer | null

The subtotal amount to be paid, in minor units. For example, $12.50 is represented as 1250.

Example:

1250

suggested_payment_term

object | null

The suggested date and corresponding discount in which payable could be paid. The date is in the YYYY-MM-DD format. The discount is calculated as X * (10^-4) - for example, 100 is 1%, 25 is 0,25%, 10000 is 100 %. Date varies depending on the payment terms and may even be equal to the due date with discount 0.

Show child attributes

Example:

{ "date": "2023-06-11", "discount": 200 }

Accounts receivable

Accounts payable

Expense Management

Approvals

Payments

Counterparts

Accounting & ledger

Documents & templates

Organization & access

Platform & integration

Mark payable as paid

Authorizations

Headers

Path Parameters

Body

Response