Billing Platform API
Billing Platform API
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/INVOICE_GROUP \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"EntityFieldId": 0,
"ShowGroupingDetail": 0,
"InsertPageBreak": 0,
"HideEmptyGroupFlag": 0,
"FilterLogic": "string",
"DetailPreviewRows": "string",
"GroupPreviewRows": "string",
"InsertPageGroupBreak": 0,
"GroupOrder": "string",
"Description": "string",
"NamePrefix": "string",
"NameSuffix": "string",
"FieldLabel": "string",
"ParentInvoiceGroupId": 0,
"Type": "string",
"ExternalKey": "string",
"Updated": "string",
"UpdatedUserId": "string",
"CreatedUserId": "string",
"Id": "string",
"InvoiceTemplateId": 0,
"Created": "string",
"FieldName": "string"
}
}'
{ "retrieveResponse": { "EntityFieldId": 0, "ShowGroupingDetail": 0, "InsertPageBreak": 0, "HideEmptyGroupFlag": 0, "FilterLogic": "string", "DetailPreviewRows": "string", "GroupPreviewRows": "string", "InsertPageGroupBreak": 0, "GroupOrder": "string", "Description": "string", "NamePrefix": "string", "NameSuffix": "string", "FieldLabel": "string", "ParentInvoiceGroupId": 0, "Type": "string", "ExternalKey": "string", "Updated": "string", "UpdatedUserId": "string", "CreatedUserId": "string", "Id": "string", "InvoiceTemplateId": 0, "Created": "string", "FieldName": "string" } }
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/INVOICE_GROUP \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"EntityFieldId": 0,
"ShowGroupingDetail": 0,
"InsertPageBreak": 0,
"HideEmptyGroupFlag": 0,
"FilterLogic": "string",
"DetailPreviewRows": "string",
"GroupPreviewRows": "string",
"InsertPageGroupBreak": 0,
"GroupOrder": "string",
"Description": "string",
"NamePrefix": "string",
"NameSuffix": "string",
"FieldLabel": "string",
"ParentInvoiceGroupId": 0,
"Type": "string",
"ExternalKey": "string",
"Updated": "string",
"UpdatedUserId": "string",
"CreatedUserId": "string",
"Id": "string",
"InvoiceTemplateId": 0,
"Created": "string",
"FieldName": "string"
}
}'
{ "retrieveResponse": { "EntityFieldId": 0, "ShowGroupingDetail": 0, "InsertPageBreak": 0, "HideEmptyGroupFlag": 0, "FilterLogic": "string", "DetailPreviewRows": "string", "GroupPreviewRows": "string", "InsertPageGroupBreak": 0, "GroupOrder": "string", "Description": "string", "NamePrefix": "string", "NameSuffix": "string", "FieldLabel": "string", "ParentInvoiceGroupId": 0, "Type": "string", "ExternalKey": "string", "Updated": "string", "UpdatedUserId": "string", "CreatedUserId": "string", "Id": "string", "InvoiceTemplateId": 0, "Created": "string", "FieldName": "string" } }
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/rest/2.0/INVOICE_GROUP \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"EntityFieldId": 0,
"ShowGroupingDetail": 0,
"InsertPageBreak": 0,
"HideEmptyGroupFlag": 0,
"FilterLogic": "string",
"DetailPreviewRows": "string",
"GroupPreviewRows": "string",
"InsertPageGroupBreak": 0,
"GroupOrder": "string",
"Description": "string",
"NamePrefix": "string",
"NameSuffix": "string",
"FieldLabel": "string",
"ParentInvoiceGroupId": 0,
"Type": "string",
"ExternalKey": "string",
"Updated": "string",
"UpdatedUserId": "string",
"CreatedUserId": "string",
"Id": "string",
"InvoiceTemplateId": 0,
"Created": "string",
"FieldName": "string"
},
"externalIDFieldName": "ExternalKey"
}'
{ "upsertResponse": [ { … } ] }