curl --request GET \
--url https://api.sandbox.tesouro.com/finops/v1/receivables/required-fields \
--header 'Authorization: Bearer <token>' \
--header 'x-finops-version: <x-finops-version>' \
--header 'x-organization-id: <x-organization-id>'{
"counterpart": {
"tax_id": {
"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.",
"required": false
},
"vat_id": {
"description": "The counterpart's VAT (Value Added Tax) identification number. This field is required for counterparts that are VAT-registered.",
"required": false
}
},
"entity": {
"tax_id": {
"description": "The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered.",
"required": false
},
"vat_id": {
"description": "The entity's VAT (Value Added Tax) identification number. This field is required for entities that are VAT-registered.",
"required": false
}
},
"line_item": {
"measure_unit": {
"description": "Unit used to measure the quantity of the product (e.g. items, meters, kilograms)",
"required": false
},
"tax_rate_value": {
"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.",
"required": false
},
"vat_rate_id": {
"description": "Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan.",
"required": false
}
}
}Get field requirements for invoice creation given the entity and counterpart details.
curl --request GET \
--url https://api.sandbox.tesouro.com/finops/v1/receivables/required-fields \
--header 'Authorization: Bearer <token>' \
--header 'x-finops-version: <x-finops-version>' \
--header 'x-organization-id: <x-organization-id>'{
"counterpart": {
"tax_id": {
"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.",
"required": false
},
"vat_id": {
"description": "The counterpart's VAT (Value Added Tax) identification number. This field is required for counterparts that are VAT-registered.",
"required": false
}
},
"entity": {
"tax_id": {
"description": "The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered.",
"required": false
},
"vat_id": {
"description": "The entity's VAT (Value Added Tax) identification number. This field is required for entities that are VAT-registered.",
"required": false
}
},
"line_item": {
"measure_unit": {
"description": "Unit used to measure the quantity of the product (e.g. items, meters, kilograms)",
"required": false
},
"tax_rate_value": {
"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.",
"required": false
},
"vat_rate_id": {
"description": "Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan.",
"required": false
}
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The ID of the entity that owns the requested resource.
"9d2b4c8f-2087-4738-ba91-7359683c49a4"
AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, IC, CV, KY, CF, EA, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, MK, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, SS, GS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, BL, BQ, CW, MF, SX individual, organization Was this page helpful?