Skip to main content
GET
/
payables
/
{payable_id}
Get a payable by ID
curl --request GET \
  --url https://api.sandbox.monite.com/v1/payables/{payable_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "credit_notes": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "submitted_for_approval",
      "document_id": "CN-123456",
      "issued_at": "2024-01-15",
      "total_amount": 1000
    }
  ],
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payable_origin": "upload",
  "source_of_payable_data": "ocr",
  "status": "draft",
  "amount_due": 1000,
  "amount_paid": 1000,
  "amount_to_pay": 1000,
  "approval_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "counterpart": {
    "address": {
      "city": "Berlin",
      "country": "DE",
      "line1": "Flughafenstrasse 52",
      "line2": "<string>",
      "postal_code": "10115",
      "state": "<string>"
    },
    "bank_account": {
      "account_holder_name": "<string>",
      "account_number": "123456789012",
      "bic": "DEUTDE2HXXX",
      "iban": "<string>",
      "routing_number": "<string>",
      "sort_code": "<string>"
    },
    "email": "acme@example.com",
    "name": "Acme Inc.",
    "phone": "5551231234",
    "tax_id": "DE12345678",
    "vat_id": {
      "country": "AF",
      "type": "<string>",
      "value": "<string>"
    }
  },
  "counterpart_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "counterpart_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "counterpart_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "counterpart_raw_data": {
    "address": {
      "city": "Berlin",
      "country": "DE",
      "line1": "Flughafenstrasse 52",
      "line2": "<string>",
      "postal_code": "10115",
      "state": "<string>"
    },
    "bank_account": {
      "account_holder_name": "<string>",
      "account_number": "123456789012",
      "bic": "DEUTDE2HXXX",
      "iban": "<string>",
      "routing_number": "<string>",
      "sort_code": "<string>"
    },
    "email": "acme@example.com",
    "name": "Acme Inc.",
    "phone": "5551231234",
    "tax_id": "DE12345678",
    "vat_id": {
      "country": "AF",
      "type": "<string>",
      "value": "<string>"
    }
  },
  "counterpart_vat_id_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by_role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "EUR",
  "currency_exchange": {
    "default_currency_code": "<string>",
    "rate": 123,
    "total": 123
  },
  "description": "<string>",
  "discount": 500,
  "document_id": "DE2287",
  "due_date": "2023-12-25",
  "einvoice_file_url": "https://bucketname.s3.amazonaws.com/12345/67890.xml",
  "enforce_approval_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "file": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "file_type": "payables",
    "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
    "mimetype": "application/pdf",
    "name": "invoice.pdf",
    "region": "eu-central-1",
    "size": 24381,
    "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
    "pages": [],
    "previews": []
  },
  "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "issued_at": "2023-12-25",
  "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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ocr_status": "processing",
  "other_extracted_data": {
    "counterpart_account_id": "DEUTDEFF",
    "counterpart_account_number": "<string>",
    "counterpart_address": "<string>",
    "counterpart_address_object": {
      "city": "Berlin",
      "country": "DE",
      "line1": "Flughafenstrasse 52",
      "line2": "<string>",
      "original_country_name": "Berlin",
      "postal_code": "10115",
      "state": "<string>"
    },
    "counterpart_branch_number": "<string>",
    "counterpart_email": "<string>",
    "counterpart_name": "Monite GMbH",
    "counterpart_routing_number": "<string>",
    "counterpart_vat_id": "DE88939004",
    "currency": "EUR",
    "discount_raw": 123,
    "document_due_date": "<string>",
    "document_id": "CST-13341",
    "document_issued_at_date": "<string>",
    "line_items_raw": [
      {
        "description": "Impact Players : How to Take the Lead , Play Bigger , and Multiply Your",
        "item_adjusted": false,
        "line_item_ocr_id": "<string>",
        "quantity": 1.2,
        "total_excl_vat": 120,
        "total_incl_vat": 135,
        "unit": "meters",
        "unit_price": 100,
        "vat_amount": 15,
        "vat_percentage": 12.5
      }
    ],
    "payment_terms_raw": [
      "<string>"
    ],
    "purchase_order_number": "1234",
    "tax_payer_id": "12345678901",
    "total_excl_vat_raw": 77,
    "total_paid_amount_raw": 50,
    "total_raw": 70,
    "total_vat_amount_raw": 7,
    "total_vat_rate_raw": 12.5,
    "type": "invoice"
  },
  "paid_at": "2023-11-07T05:31:56Z",
  "partner_metadata": {},
  "payment_terms": {
    "name": "<string>",
    "term_final": {
      "number_of_days": 123
    },
    "description": "<string>",
    "term_1": {
      "discount": 123,
      "number_of_days": 123
    },
    "term_2": {
      "discount": 123,
      "number_of_days": 123
    }
  },
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "purchase_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sender": "hello@example.com",
  "subtotal": 1250,
  "suggested_payment_term": {
    "date": "2023-12-25",
    "discount": 5000
  },
  "tags": [
    {
      "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
      "created_at": "2022-09-07T16:35:18.484507+00:00",
      "updated_at": "2022-09-07T16:35:18.484507+00:00",
      "name": "Marketing",
      "category": "department",
      "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
      "description": "Tag for the Marketing Department"
    }
  ],
  "tax": 2000,
  "tax_amount": 250,
  "total_amount": 1500,
  "total_amount_with_credit_notes": 123,
  "was_created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

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

Headers

x-monite-version
string<date>
required
x-monite-entity-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

Response

Successful Response

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

id
string<uuid>
required

A unique ID assigned to this payable.

created_at
string<date-time>
required

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

updated_at
string<date-time>
required

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

credit_notes
object[]
required

The list of linked credit notes of the payable.

entity_id
string<uuid>
required

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

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,
einvoicing
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,
einvoicing
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
amount_due
integer

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

Example:

1000

amount_paid
integer

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

Example:

1000

amount_to_pay
integer

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

Example:

1000

approval_policy_id
string<uuid>

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

counterpart
object

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

counterpart_address_id
string<uuid>

The ID of counterpart address object stored in counterparts service

counterpart_bank_account_id
string<uuid>

The ID of counterpart bank account object stored in counterparts service

counterpart_id
string<uuid>

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

counterpart_raw_data
object

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

counterpart_vat_id_id
string<uuid>

The ID of counterpart VAT ID object stored in counterparts service

created_by_role_id
string<uuid>

The ID of the role that the entity user who created this payable had at that time. If the payable was created using a partner access token, the value is null.

currency
enum<string>

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:

"EUR"

currency_exchange
object
description
string

An arbitrary description of this payable.

discount
integer

The value of the additional discount that will be applied to the total amount. in minor units. For example, $12.50 is represented as 1250.

Example:

500

document_id
string

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:

"DE2287"

due_date
string<date>

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.

einvoice_file_url
string

The URL to download the original e-invoice file.

Example:

"https://bucketname.s3.amazonaws.com/12345/67890.xml"

enforce_approval_policy_id
string<uuid>

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.

file
object

The original file from which this payable was created.

file_id
string<uuid>

File id to retrieve file info from file saver.

issued_at
string<date>

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

marked_as_paid_by_entity_user_id
string<uuid>

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

Example:

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

marked_as_paid_with_comment
string

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>

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

ocr_status
enum<string>

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
other_extracted_data
object

Data extracted from the uploaded payable by OCR.

paid_at
string<date-time>

The date by which the payable was paid

partner_metadata
object

Metadata for partner needs

payment_terms
object

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

project_id
string<uuid>

Project ID of a payable.

purchase_order_id
string<uuid>

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

sender
string<email>

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

Example:

"hello@example.com"

subtotal
integer

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

Example:

1250

suggested_payment_term
object

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.

tags
object[]

A list of user-defined tags (labels) assigned to this payable. Tags can be used to trigger a specific approval policy for this payable.

tax
integer

Registered tax percentage applied for a service price in minor units, e.g. 200 means 2%, 1050 means 10.5%.

Example:

2000

tax_amount
integer

Tax amount in minor units. For example, $12.50 is represented as 1250.

Example:

250

total_amount
integer

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

Example:

1500

total_amount_with_credit_notes
integer

The total price of the payable in minor units, excluding all issued credit notes.

was_created_by_user_id
string<uuid>