Get a mail sent by receivable

GET

/receivables/:receivable_id/mails/:mail_id

Path parameters

receivable_idstringRequired

mail_idstringRequired

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.

Response

Successful Response

idstringformat: "uuid"

created_atdatetime

The time the mail task was created

updated_atdatetime

The time the mail task was updated

statusenum

Allowed values: pendingprocessingsentpartially_sentfailed

The status of the mail sent by receivable

recipientsobjectOptional

Errors

GET

1 curl https://api.sandbox.monite.com/v1/receivables/receivable_id/mails/mail_id \
2      -H "x-monite-version: 2024-05-25" \
3      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "id": "id",
3   "created_at": "2024-01-15T09:30:00Z",
4   "updated_at": "2024-01-15T09:30:00Z",
5   "status": "pending",
6   "recipients": {
7     "bcc": [
8       {
9         "email": "email",
10         "is_success": true,
11         "error": "error"
12       }
13     ],
14     "cc": [
15       {
16         "email": "email",
17         "is_success": true,
18         "error": "error"
19       }
20     ],
21     "to": [
22       {
23         "email": "email",
24         "is_success": true,
25         "error": "error"
26       }
27     ]
28   }
29 }

Mark an invoice as paid

Up Next

1	curl https://api.sandbox.monite.com/v1/receivables/receivable_id/mails/mail_id \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>"

1	{
2	"id": "id",
3	"created_at": "2024-01-15T09:30:00Z",
4	"updated_at": "2024-01-15T09:30:00Z",
5	"status": "pending",
6	"recipients": {
7	"bcc": [
8	{
9	"email": "email",
10	"is_success": true,
11	"error": "error"
12	}
13	],
14	"cc": [
15	{
16	"email": "email",
17	"is_success": true,
18	"error": "error"
19	}
20	],
21	"to": [
22	{
23	"email": "email",
24	"is_success": true,
25	"error": "error"
26	}
27	]
28	}
29	}