Get required field names for invoice creation

GET

/receivables/required_fields

Get field requirements for invoice creation given the entity and counterpart details.

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.

Query parameters

counterpart_idstringRequired

counterpart_billing_address_idstringRequired

entity_vat_id_idstringOptional

counterpart_vat_id_idstringOptional

Response

Successful Response

counterpartobjectOptional

Object describing the required fields for counterpart

entityobjectOptional

Object describing the required fields for entity

line_itemobjectOptional

Object describing the required fields for line items

Errors

GET

1 curl -G https://api.sandbox.monite.com/v1/receivables/required_fields \
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      -d counterpart_id=counterpart_id \
6      -d counterpart_billing_address_id=counterpart_billing_address_id

200Retrieved

1 {
2   "counterpart": {
3     "tax_id": {
4       "description": "The counterpart's taxpayer identification number or tax ID. For identification purposes, this field may be required for counterparts that are not VAT-registered.",
5       "required": false
6     },
7     "vat_id": {
8       "description": "The counterpart's VAT (Value Added Tax) identification number. This field is required for counterparts that are VAT-registered.",
9       "required": true
10     }
11   },
12   "entity": {
13     "tax_id": {
14       "description": "The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered.",
15       "required": false
16     },
17     "vat_id": {
18       "description": "The entity's VAT (Value Added Tax) identification number. This field is required for entities that are VAT-registered.",
19       "required": true
20     }
21   },
22   "line_item": {
23     "measure_unit": {
24       "description": "Unit used to measure the quantity of the product (e.g. items, meters, kilograms)",
25       "required": true
26     },
27     "tax_rate_value": {
28       "description": "Percent minor units. Example: 12.5% is 1250. This field is only required on invoices issued by entities in the US, Pakistan, and other unsupported countries.",
29       "required": false
30     },
31     "vat_rate_id": {
32       "description": "Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan.",
33       "required": true
34     }
35   }
36 }

Get email template variables

Up Next

1	curl -G https://api.sandbox.monite.com/v1/receivables/required_fields \
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	-d counterpart_id=counterpart_id \
6	-d counterpart_billing_address_id=counterpart_billing_address_id

1	{
2	"counterpart": {
3	"tax_id": {
4	"description": "The counterpart's taxpayer identification number or tax ID. For identification purposes, this field may be required for counterparts that are not VAT-registered.",
5	"required": false
6	},
7	"vat_id": {
8	"description": "The counterpart's VAT (Value Added Tax) identification number. This field is required for counterparts that are VAT-registered.",
9	"required": true
10	}
11	},
12	"entity": {
13	"tax_id": {
14	"description": "The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered.",
15	"required": false
16	},
17	"vat_id": {
18	"description": "The entity's VAT (Value Added Tax) identification number. This field is required for entities that are VAT-registered.",
19	"required": true
20	}
21	},
22	"line_item": {
23	"measure_unit": {
24	"description": "Unit used to measure the quantity of the product (e.g. items, meters, kilograms)",
25	"required": true
26	},
27	"tax_rate_value": {
28	"description": "Percent minor units. Example: 12.5% is 1250. This field is only required on invoices issued by entities in the US, Pakistan, and other unsupported countries.",
29	"required": false
30	},
31	"vat_rate_id": {
32	"description": "Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan.",
33	"required": true
34	}
35	}
36	}