Billing Platform API
Billing Platform API
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/INVOICE/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "BillingCycleStartDate": "string", "EventInvoiceCycleId": 0, "LastEmailDeliveryDate": "string", "Id": "string", "PaymentStatus": "string", "DueDate": "string", "ReopenedByInvoiceId": 0, "Updated": "string", "VoidedByCreditId": 0, "AccountingPeriodId": 0, "PdfCreatedDate": "string", "BillableFlag": 0, "CreatedUserId": "string", "Disputed": 0, "MigratedInvoice": 0, "MassUpdateError": "string", "BillingCycleEndDate": "string", "BillingProfileId": 0, "Created": "string", "AgingInterval": "string", "Status": "string", "ClosedDate": "string", "ApprovalStatus": "string", "ApprovalUserId": "string", "CreatedByInvoiceId": 0, "ApprovalDate": "string", "MoveInvoiceDescription": "string", "UpdatedUserId": "string", "EstimateDate": "string", "InvoiceReburnAction": "string", "VoidFlag": 0, "EstimatedStatus": "string", "AvailableActions": "string", "PendingActions": "string", "CurrentAction": 0, "LastAction": 0, "ActivityStartDate": "string", "ActivityEndDate": "string", "FileName": "string", "ManualCloseApprovedFlag": "string", "SuppressBulkCloseFlag": "string", "ReburnFlag": "string", "LastGatewayKey": 0, "NextEstimateDate": "string", "SendInvoiceEmail": 0, "AccountStrategyId": 0 } }
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/INVOICE?queryAnsiSql=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "BillingCycleStartDate": "string", "EventInvoiceCycleId": 0, "LastEmailDeliveryDate": "string", "Id": "string", "PaymentStatus": "string", "DueDate": "string", "ReopenedByInvoiceId": 0, "Updated": "string", "VoidedByCreditId": 0, "AccountingPeriodId": 0, "PdfCreatedDate": "string", "BillableFlag": 0, "CreatedUserId": "string", "Disputed": 0, "MigratedInvoice": 0, "MassUpdateError": "string", "BillingCycleEndDate": "string", "BillingProfileId": 0, "Created": "string", "AgingInterval": "string", "Status": "string", "ClosedDate": "string", "ApprovalStatus": "string", "ApprovalUserId": "string", "CreatedByInvoiceId": 0, "ApprovalDate": "string", "MoveInvoiceDescription": "string", "UpdatedUserId": "string", "EstimateDate": "string", "InvoiceReburnAction": "string", "VoidFlag": 0, "EstimatedStatus": "string", "AvailableActions": "string", "PendingActions": "string", "CurrentAction": 0, "LastAction": 0, "ActivityStartDate": "string", "ActivityEndDate": "string", "FileName": "string", "ManualCloseApprovedFlag": "string", "SuppressBulkCloseFlag": "string", "ReburnFlag": "string", "LastGatewayKey": 0, "NextEstimateDate": "string", "SendInvoiceEmail": 0, "AccountStrategyId": 0 } }
curl -i -X POST \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/INVOICE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "BillingCycleStartDate": "string", "EventInvoiceCycleId": 0, "LastEmailDeliveryDate": "string", "Id": "string", "PaymentStatus": "string", "DueDate": "string", "ReopenedByInvoiceId": 0, "Updated": "string", "VoidedByCreditId": 0, "AccountingPeriodId": 0, "PdfCreatedDate": "string", "BillableFlag": 0, "CreatedUserId": "string", "Disputed": 0, "MigratedInvoice": 0, "MassUpdateError": "string", "BillingCycleEndDate": "string", "BillingProfileId": 0, "Created": "string", "AgingInterval": "string", "Status": "string", "ClosedDate": "string", "ApprovalStatus": "string", "ApprovalUserId": "string", "CreatedByInvoiceId": 0, "ApprovalDate": "string", "MoveInvoiceDescription": "string", "UpdatedUserId": "string", "EstimateDate": "string", "InvoiceReburnAction": "string", "VoidFlag": 0, "EstimatedStatus": "string", "AvailableActions": "string", "PendingActions": "string", "CurrentAction": 0, "LastAction": 0, "ActivityStartDate": "string", "ActivityEndDate": "string", "FileName": "string", "ManualCloseApprovedFlag": "string", "SuppressBulkCloseFlag": "string", "ReburnFlag": "string", "LastGatewayKey": 0, "NextEstimateDate": "string", "SendInvoiceEmail": 0, "AccountStrategyId": 0 } }'
{ "retrieveResponse": { "BillingCycleStartDate": "string", "EventInvoiceCycleId": 0, "LastEmailDeliveryDate": "string", "Id": "string", "PaymentStatus": "string", "DueDate": "string", "ReopenedByInvoiceId": 0, "Updated": "string", "VoidedByCreditId": 0, "AccountingPeriodId": 0, "PdfCreatedDate": "string", "BillableFlag": 0, "CreatedUserId": "string", "Disputed": 0, "MigratedInvoice": 0, "MassUpdateError": "string", "BillingCycleEndDate": "string", "BillingProfileId": 0, "Created": "string", "AgingInterval": "string", "Status": "string", "ClosedDate": "string", "ApprovalStatus": "string", "ApprovalUserId": "string", "CreatedByInvoiceId": 0, "ApprovalDate": "string", "MoveInvoiceDescription": "string", "UpdatedUserId": "string", "EstimateDate": "string", "InvoiceReburnAction": "string", "VoidFlag": 0, "EstimatedStatus": "string", "AvailableActions": "string", "PendingActions": "string", "CurrentAction": 0, "LastAction": 0, "ActivityStartDate": "string", "ActivityEndDate": "string", "FileName": "string", "ManualCloseApprovedFlag": "string", "SuppressBulkCloseFlag": "string", "ReburnFlag": "string", "LastGatewayKey": 0, "NextEstimateDate": "string", "SendInvoiceEmail": 0, "AccountStrategyId": 0 } }
curl -i -X PUT \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/INVOICE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "BillingCycleStartDate": "string", "EventInvoiceCycleId": 0, "LastEmailDeliveryDate": "string", "Id": "string", "PaymentStatus": "string", "DueDate": "string", "ReopenedByInvoiceId": 0, "Updated": "string", "VoidedByCreditId": 0, "AccountingPeriodId": 0, "PdfCreatedDate": "string", "BillableFlag": 0, "CreatedUserId": "string", "Disputed": 0, "MigratedInvoice": 0, "MassUpdateError": "string", "BillingCycleEndDate": "string", "BillingProfileId": 0, "Created": "string", "AgingInterval": "string", "Status": "string", "ClosedDate": "string", "ApprovalStatus": "string", "ApprovalUserId": "string", "CreatedByInvoiceId": 0, "ApprovalDate": "string", "MoveInvoiceDescription": "string", "UpdatedUserId": "string", "EstimateDate": "string", "InvoiceReburnAction": "string", "VoidFlag": 0, "EstimatedStatus": "string", "AvailableActions": "string", "PendingActions": "string", "CurrentAction": 0, "LastAction": 0, "ActivityStartDate": "string", "ActivityEndDate": "string", "FileName": "string", "ManualCloseApprovedFlag": "string", "SuppressBulkCloseFlag": "string", "ReburnFlag": "string", "LastGatewayKey": 0, "NextEstimateDate": "string", "SendInvoiceEmail": 0, "AccountStrategyId": 0 } }'
{ "retrieveResponse": { "BillingCycleStartDate": "string", "EventInvoiceCycleId": 0, "LastEmailDeliveryDate": "string", "Id": "string", "PaymentStatus": "string", "DueDate": "string", "ReopenedByInvoiceId": 0, "Updated": "string", "VoidedByCreditId": 0, "AccountingPeriodId": 0, "PdfCreatedDate": "string", "BillableFlag": 0, "CreatedUserId": "string", "Disputed": 0, "MigratedInvoice": 0, "MassUpdateError": "string", "BillingCycleEndDate": "string", "BillingProfileId": 0, "Created": "string", "AgingInterval": "string", "Status": "string", "ClosedDate": "string", "ApprovalStatus": "string", "ApprovalUserId": "string", "CreatedByInvoiceId": 0, "ApprovalDate": "string", "MoveInvoiceDescription": "string", "UpdatedUserId": "string", "EstimateDate": "string", "InvoiceReburnAction": "string", "VoidFlag": 0, "EstimatedStatus": "string", "AvailableActions": "string", "PendingActions": "string", "CurrentAction": 0, "LastAction": 0, "ActivityStartDate": "string", "ActivityEndDate": "string", "FileName": "string", "ManualCloseApprovedFlag": "string", "SuppressBulkCloseFlag": "string", "ReburnFlag": "string", "LastGatewayKey": 0, "NextEstimateDate": "string", "SendInvoiceEmail": 0, "AccountStrategyId": 0 } }
curl -i -X PATCH \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/INVOICE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "BillingCycleStartDate": "string", "EventInvoiceCycleId": 0, "LastEmailDeliveryDate": "string", "Id": "string", "PaymentStatus": "string", "DueDate": "string", "ReopenedByInvoiceId": 0, "Updated": "string", "VoidedByCreditId": 0, "AccountingPeriodId": 0, "PdfCreatedDate": "string", "BillableFlag": 0, "CreatedUserId": "string", "Disputed": 0, "MigratedInvoice": 0, "MassUpdateError": "string", "BillingCycleEndDate": "string", "BillingProfileId": 0, "Created": "string", "AgingInterval": "string", "Status": "string", "ClosedDate": "string", "ApprovalStatus": "string", "ApprovalUserId": "string", "CreatedByInvoiceId": 0, "ApprovalDate": "string", "MoveInvoiceDescription": "string", "UpdatedUserId": "string", "EstimateDate": "string", "InvoiceReburnAction": "string", "VoidFlag": 0, "EstimatedStatus": "string", "AvailableActions": "string", "PendingActions": "string", "CurrentAction": 0, "LastAction": 0, "ActivityStartDate": "string", "ActivityEndDate": "string", "FileName": "string", "ManualCloseApprovedFlag": "string", "SuppressBulkCloseFlag": "string", "ReburnFlag": "string", "LastGatewayKey": 0, "NextEstimateDate": "string", "SendInvoiceEmail": 0, "AccountStrategyId": 0 }, "externalIDFieldName": "Id" }'
{ "upsertResponse": [ { … } ] }
curl -i -X DELETE \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/delete/INVOICE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "Id": "string" } }'
{ "retrieveResponse": { "BillingCycleStartDate": "string", "EventInvoiceCycleId": 0, "LastEmailDeliveryDate": "string", "Id": "string", "PaymentStatus": "string", "DueDate": "string", "ReopenedByInvoiceId": 0, "Updated": "string", "VoidedByCreditId": 0, "AccountingPeriodId": 0, "PdfCreatedDate": "string", "BillableFlag": 0, "CreatedUserId": "string", "Disputed": 0, "MigratedInvoice": 0, "MassUpdateError": "string", "BillingCycleEndDate": "string", "BillingProfileId": 0, "Created": "string", "AgingInterval": "string", "Status": "string", "ClosedDate": "string", "ApprovalStatus": "string", "ApprovalUserId": "string", "CreatedByInvoiceId": 0, "ApprovalDate": "string", "MoveInvoiceDescription": "string", "UpdatedUserId": "string", "EstimateDate": "string", "InvoiceReburnAction": "string", "VoidFlag": 0, "EstimatedStatus": "string", "AvailableActions": "string", "PendingActions": "string", "CurrentAction": 0, "LastAction": 0, "ActivityStartDate": "string", "ActivityEndDate": "string", "FileName": "string", "ManualCloseApprovedFlag": "string", "SuppressBulkCloseFlag": "string", "ReburnFlag": "string", "LastGatewayKey": 0, "NextEstimateDate": "string", "SendInvoiceEmail": 0, "AccountStrategyId": 0 } }