Upload a credit note from a file

POST

/payable_credit_notes/upload_from_file

Upload an incoming credit note (payable) in PDF, PNG, JPEG, or TIFF format and scan its contents. The maximum file size is 10MB.

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Request

This endpoint expects a multipart form containing a file.

filefileRequired

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_onstringOptionalformat: "uuid"

ID of the payable this credit note is based on

based_on_document_idstringOptional<=255 characters

The document ID of the original payable that this credit note refers to

counterpart_address_idstringOptionalformat: "uuid"

ID of the counterpart’s address

counterpart_bank_account_idstringOptionalformat: "uuid"

ID of the counterpart’s bank account

counterpart_idstringOptionalformat: "uuid"

ID of the counterpart

counterpart_vat_id_idstringOptionalformat: "uuid"

ID of the counterpart’s VAT registration

created_by_external_user_idstringOptional<=255 characters

External system’s user ID for the creator

created_by_external_user_namestringOptional<=255 characters

Name of the external user who created the credit note

created_by_user_idstringOptionalformat: "uuid"

ID of the user who created the credit note

currencystringOptional<=5 characters

The currency code

currency_exchangeobjectOptional

descriptionstringOptional<=255 characters

Description of the credit note

document_idstringOptional<=255 characters

The credit note’s unique document number

file_idstringOptionalformat: "uuid"

The id of the credit note file stored in the file saver.

file_urlstringOptional

The URL of the credit note file stored in the file saver.

issued_atstringOptionalformat: "date"

Date when the credit note was issued

ocr_request_idstringOptionalformat: "uuid"

ID of the OCR processing request

ocr_statusstringOptional<=10 characters

Status of OCR processing

project_idstringOptionalformat: "uuid"

ID of the associated project

senderstringOptional<=255 characters

Email address of the sender

subtotalintegerOptional

The subtotal amount before taxes

tagslist of objectsOptional

List of tags associated with this credit note

taxintegerOptional

The tax percentage

tax_amountintegerOptional

The calculated tax amount

total_amountintegerOptional

The total amount including taxes

Errors

POST

1 curl -X POST https://api.sandbox.monite.com/v1/payable_credit_notes/upload_from_file \
2      -H "x-monite-version: 2024-05-25" \
3      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4      -H "Authorization: Bearer <token>" \
5      -H "Content-Type: multipart/form-data" \
6      -F file=@<file1>

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_address_id": "123e4567-e89b-12d3-a456-426614174000",
12   "counterpart_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
13   "counterpart_id": "123e4567-e89b-12d3-a456-426614174000",
14   "counterpart_vat_id_id": "123e4567-e89b-12d3-a456-426614174000",
15   "created_by_external_user_id": "ext_user_123",
16   "created_by_external_user_name": "John Doe",
17   "created_by_user_id": "123e4567-e89b-12d3-a456-426614174000",
18   "currency": "EUR",
19   "currency_exchange": {
20     "default_currency_code": "default_currency_code",
21     "rate": 1.1,
22     "total": 1.1
23   },
24   "description": "Credit note for returned items from invoice INV-2287",
25   "document_id": "CN-2287",
26   "file_id": "123e4567-e89b-12d3-a456-426614174000",
27   "file_url": "file_url",
28   "issued_at": "2024-01-15",
29   "ocr_request_id": "123e4567-e89b-12d3-a456-426614174000",
30   "ocr_status": "completed",
31   "project_id": "123e4567-e89b-12d3-a456-426614174000",
32   "sender": "supplier@example.com",
33   "subtotal": 1000,
34   "tags": [
35     {
36       "id": "123e4567-e89b-12d3-a456-426614174000",
37       "created_at": "2022-09-07T16:35:18Z",
38       "updated_at": "2022-09-07T16:35:18Z",
39       "name": "Department A",
40       "category": "department",
41       "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
42       "description": "Tag for the Marketing Department"
43     }
44   ],
45   "tax": 20,
46   "tax_amount": 200,
47   "total_amount": 1200
48 }

Get a credit note by ID

Up Next

1	curl -X POST https://api.sandbox.monite.com/v1/payable_credit_notes/upload_from_file \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: multipart/form-data" \
6	-F file=@<file1>

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_address_id": "123e4567-e89b-12d3-a456-426614174000",
12	"counterpart_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
13	"counterpart_id": "123e4567-e89b-12d3-a456-426614174000",
14	"counterpart_vat_id_id": "123e4567-e89b-12d3-a456-426614174000",
15	"created_by_external_user_id": "ext_user_123",
16	"created_by_external_user_name": "John Doe",
17	"created_by_user_id": "123e4567-e89b-12d3-a456-426614174000",
18	"currency": "EUR",
19	"currency_exchange": {
20	"default_currency_code": "default_currency_code",
21	"rate": 1.1,
22	"total": 1.1
23	},
24	"description": "Credit note for returned items from invoice INV-2287",
25	"document_id": "CN-2287",
26	"file_id": "123e4567-e89b-12d3-a456-426614174000",
27	"file_url": "file_url",
28	"issued_at": "2024-01-15",
29	"ocr_request_id": "123e4567-e89b-12d3-a456-426614174000",
30	"ocr_status": "completed",
31	"project_id": "123e4567-e89b-12d3-a456-426614174000",
32	"sender": "supplier@example.com",
33	"subtotal": 1000,
34	"tags": [
35	{
36	"id": "123e4567-e89b-12d3-a456-426614174000",
37	"created_at": "2022-09-07T16:35:18Z",
38	"updated_at": "2022-09-07T16:35:18Z",
39	"name": "Department A",
40	"category": "department",
41	"created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
42	"description": "Tag for the Marketing Department"
43	}
44	],
45	"tax": 20,
46	"tax_amount": 200,
47	"total_amount": 1200
48	}