API StatusPartner Portal
HomeGuidesAPI ExplorerSDKsGitHubSupport
HomeGuidesAPI ExplorerSDKsGitHubSupport
  • API Concepts
    • Overview
    • Environments and URLs
    • Authentication
    • API versioning
    • Rate limiting
    • HTTP headers
    • Pagination, sorting, and filtering
  • General
  • Common
  • Accounts payable
  • Accounts receivable
  • E-invoicing
  • Payments
  • Accounting integration
  • Expense management
  • Utilities
LogoLogo
API StatusPartner Portal
Accounts payableCredit notes

Cancel OCR of a credit note

POST
/payable_credit_notes/:credit_note_id/cancel_ocr
POST
/v1/payable_credit_notes/:credit_note_id/cancel_ocr
1curl -X POST https://api.sandbox.monite.com/v1/payable_credit_notes/credit_note_id/cancel_ocr \
2     -H "x-monite-version: 2024-05-25" \
3     -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4     -H "Authorization: Bearer <token>"
Try it
1{
2  "id": "123e4567-e89b-12d3-a456-426614174000",
3  "created_at": "2024-01-15T14:30:00Z",
4  "updated_at": "2024-01-15T14:30:00Z",
5  "entity_id": "123e4567-e89b-12d3-a456-426614174000",
6  "origin": "SAP",
7  "source_of_data": "user_specified",
8  "status": "submitted_for_approval",
9  "based_on": "123e4567-e89b-12d3-a456-426614174000",
10  "based_on_document_id": "INV-2287",
11  "counterpart": {
12    "address": {
13      "city": "Berlin",
14      "country": "AF",
15      "line1": "Flughafenstrasse 52",
16      "line2": "line2",
17      "postal_code": "10115",
18      "state": "state"
19    },
20    "bank_account": {
21      "account_holder_name": "account_holder_name",
22      "account_number": "123456789012",
23      "bic": "DEUTDE2HXXX",
24      "iban": "iban",
25      "routing_number": "routing_number",
26      "sort_code": "sort_code"
27    },
28    "email": "acme@example.com",
29    "name": "Acme Inc.",
30    "phone": "5551231234",
31    "tax_id": "DE12345678",
32    "vat_id": {
33      "country": "AF",
34      "type": "type",
35      "value": "value"
36    }
37  },
38  "counterpart_address_id": "123e4567-e89b-12d3-a456-426614174000",
39  "counterpart_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
40  "counterpart_id": "123e4567-e89b-12d3-a456-426614174000",
41  "counterpart_raw": {
42    "address": {
43      "city": "Berlin",
44      "country": "AF",
45      "line1": "Flughafenstrasse 52",
46      "line2": "line2",
47      "postal_code": "10115",
48      "state": "state"
49    },
50    "bank_account": {
51      "account_holder_name": "account_holder_name",
52      "account_number": "123456789012",
53      "bic": "DEUTDE2HXXX",
54      "iban": "iban",
55      "routing_number": "routing_number",
56      "sort_code": "sort_code"
57    },
58    "email": "acme@example.com",
59    "name": "Acme Inc.",
60    "phone": "5551231234",
61    "tax_id": "DE12345678",
62    "vat_id": {
63      "country": "AF",
64      "type": "type",
65      "value": "value"
66    }
67  },
68  "counterpart_vat_id_id": "123e4567-e89b-12d3-a456-426614174000",
69  "created_by_external_user_id": "ext_user_123",
70  "created_by_external_user_name": "John Doe",
71  "created_by_user_id": "123e4567-e89b-12d3-a456-426614174000",
72  "currency": "EUR",
73  "currency_exchange": {
74    "default_currency_code": "default_currency_code",
75    "rate": 1.1,
76    "total": 1.1
77  },
78  "description": "Credit note for returned items from invoice INV-2287",
79  "document_id": "CN-2287",
80  "file_id": "123e4567-e89b-12d3-a456-426614174000",
81  "file_url": "file_url",
82  "issued_at": "2024-01-15",
83  "ocr_request_id": "123e4567-e89b-12d3-a456-426614174000",
84  "ocr_status": "completed",
85  "project_id": "123e4567-e89b-12d3-a456-426614174000",
86  "sender": "supplier@example.com",
87  "subtotal": 1000,
88  "tags": [
89    {
90      "id": "123e4567-e89b-12d3-a456-426614174000",
91      "created_at": "2022-09-07T16:35:18Z",
92      "updated_at": "2022-09-07T16:35:18Z",
93      "name": "Department A",
94      "category": "department",
95      "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
96      "description": "Tag for the Marketing Department"
97    }
98  ],
99  "tax": 20,
100  "tax_amount": 200,
101  "total_amount": 1200
102}
Request to cancel the OCR processing of the specified credit note.
Was this page helpful?
Previous

Get all line items of a credit note

Next
Get all line items of a credit note
Request to cancel the OCR processing of the specified credit note.

Authentication

AuthorizationBearer

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

Path Parameters

credit_note_idstringRequired

Headers

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Response

Successful Response
idstringformat: "uuid"
The unique identifier of the credit note
created_atdatetime
Date and time when the credit note was created in the system
updated_atdatetime
Date and time of the last update to the credit note
entity_idstringformat: "uuid"
The ID of the entity to which the credit note belongs
originstring<=128 characters
The origin or source system of the credit note
source_of_datastring<=128 characters

How the data was input (ocr/user_specified)

statusstring<=30 characters
The current status of the credit note in its lifecycle
based_onstring or nullformat: "uuid"
ID of the payable this credit note is based on
based_on_document_idstring or null<=255 characters
The document ID of the original payable that this credit note refers to
counterpartobject or null

Object representing de-normalized counterpart data

counterpart_address_idstring or nullformat: "uuid"
ID of the counterpart's address
counterpart_bank_account_idstring or nullformat: "uuid"
ID of the counterpart's bank account
counterpart_idstring or nullformat: "uuid"
ID of the counterpart
counterpart_rawobject or null
Object representing counterpart data which was extracted by OCR. Used for informational purposes.
counterpart_vat_id_idstring or nullformat: "uuid"
ID of the counterpart's VAT registration
created_by_external_user_idstring or null<=255 characters
External system's user ID for the creator
created_by_external_user_namestring or null<=255 characters
Name of the external user who created the credit note
created_by_user_idstring or nullformat: "uuid"
ID of the user who created the credit note
currencystring or null<=5 characters
The currency code
currency_exchangeobject or null
descriptionstring or null<=255 characters
Description of the credit note
document_idstring or null<=255 characters
The credit note's unique document number
file_idstring or nullformat: "uuid"
The id of the credit note file stored in the file saver.
file_urlstring or null
The URL of the credit note file stored in the file saver.
issued_atstring or nullformat: "date"
Date when the credit note was issued
ocr_request_idstring or nullformat: "uuid"
ID of the OCR processing request
ocr_statusstring or null<=10 characters
Status of OCR processing
project_idstring or nullformat: "uuid"
ID of the associated project
senderstring or null<=255 characters
Email address of the sender
subtotalinteger or null
The subtotal amount before taxes
tagslist of objects or null
List of tags associated with this credit note
taxinteger or null
The tax percentage
tax_amountinteger or null
The calculated tax amount
total_amountinteger or null
The total amount including taxes

Errors

Successful Response