Billing Platform API
Billing Platform API
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/BILLING_PROFILE/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "CreditCardExpDate": "string", "Country": "string", "InvoiceDeliveryMethod": "string", "DunningInterval": "string", "AllowPricingInOtherCurrency": 0, "AchBankAbaCode": "string", "AchBankAcctType": "string", "DisablePDFGenerationOnInvoiceClose": 0, "InvoiceTemplateId": 0, "PaymentTermDays": "string", "CreditCardType": "string", "CreditCardName": "string", "Phone": "string", "InvoiceFileFormat": "string", "AchMandateStatus": "string", "Address2": "string", "CurrencyCode": 0, "StatementApprovalFlag": 0, "StatementTemplateId": "string", "StatementDeliveryMethod": "string", "PeriodCutoffDate": "string", "AchBranchCode": "string", "AchScheme": "string", "NationalIdentityNumber": "string", "Email": "string", "CreditCardCCV": "string", "AchBankAcctName": "string", "StatementEarliestDate": "string", "BillTo": "string", "BillingCycle": "string", "PoNumber": "string", "Fax": "string", "TimeZoneId": "string", "AchMandateCountry": "string", "YearlyBillingMonth": "string", "CalendarClosingMonth": "string", "SemiAnnualBillingMonth": "string", "Attention": "string", "Address1": "string", "InvoiceApprovalFlag": 0, "WeeklyBillingDate": "string", "QuarterlyBillingMonth": "string", "MonthlyBillingDate": "string", "State": "string", "Zip": "string", "EventGroupType": "string", "AchBankAcctNum": "string", "AchBankName": "string", "CreditCardToken": "string", "AchUniqueRef": "string", "TaxEngineId": 0, "AchMandateReference": "string", "BillingMethod": "string", "CreditCardNumber": "string", "City": "string", "StatementCycle": "string", "ManualCloseFlag": 0, "EventBasedBilling": 0, "PaymentGatewayCustomerId": "string", "AchMandateState": "string", "HostedPaymentPageExternalId": "string", "Id": "string", "CalendarType": "string", "CalendarClosingWeekday": "string", "Status": "string", "InvGraceDaysBeforeClosing": "string", "Created": "string", "UpdatedUserId": "string", "Updated": "string", "CreatedUserId": "string", "BillingEntity": "string", "AchMandateEnabledFlag": 0, "AchMandateStatusModifyDate": "string", "CustomerRefNum": "string", "AccountId": "string", "AchEcheckType": "string" } }
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/BILLING_PROFILE?queryAnsiSql=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "CreditCardExpDate": "string", "Country": "string", "InvoiceDeliveryMethod": "string", "DunningInterval": "string", "AllowPricingInOtherCurrency": 0, "AchBankAbaCode": "string", "AchBankAcctType": "string", "DisablePDFGenerationOnInvoiceClose": 0, "InvoiceTemplateId": 0, "PaymentTermDays": "string", "CreditCardType": "string", "CreditCardName": "string", "Phone": "string", "InvoiceFileFormat": "string", "AchMandateStatus": "string", "Address2": "string", "CurrencyCode": 0, "StatementApprovalFlag": 0, "StatementTemplateId": "string", "StatementDeliveryMethod": "string", "PeriodCutoffDate": "string", "AchBranchCode": "string", "AchScheme": "string", "NationalIdentityNumber": "string", "Email": "string", "CreditCardCCV": "string", "AchBankAcctName": "string", "StatementEarliestDate": "string", "BillTo": "string", "BillingCycle": "string", "PoNumber": "string", "Fax": "string", "TimeZoneId": "string", "AchMandateCountry": "string", "YearlyBillingMonth": "string", "CalendarClosingMonth": "string", "SemiAnnualBillingMonth": "string", "Attention": "string", "Address1": "string", "InvoiceApprovalFlag": 0, "WeeklyBillingDate": "string", "QuarterlyBillingMonth": "string", "MonthlyBillingDate": "string", "State": "string", "Zip": "string", "EventGroupType": "string", "AchBankAcctNum": "string", "AchBankName": "string", "CreditCardToken": "string", "AchUniqueRef": "string", "TaxEngineId": 0, "AchMandateReference": "string", "BillingMethod": "string", "CreditCardNumber": "string", "City": "string", "StatementCycle": "string", "ManualCloseFlag": 0, "EventBasedBilling": 0, "PaymentGatewayCustomerId": "string", "AchMandateState": "string", "HostedPaymentPageExternalId": "string", "Id": "string", "CalendarType": "string", "CalendarClosingWeekday": "string", "Status": "string", "InvGraceDaysBeforeClosing": "string", "Created": "string", "UpdatedUserId": "string", "Updated": "string", "CreatedUserId": "string", "BillingEntity": "string", "AchMandateEnabledFlag": 0, "AchMandateStatusModifyDate": "string", "CustomerRefNum": "string", "AccountId": "string", "AchEcheckType": "string" } }
curl -i -X POST \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/BILLING_PROFILE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "CreditCardExpDate": "string", "Country": "string", "InvoiceDeliveryMethod": "string", "DunningInterval": "string", "AllowPricingInOtherCurrency": 0, "AchBankAbaCode": "string", "AchBankAcctType": "string", "DisablePDFGenerationOnInvoiceClose": 0, "InvoiceTemplateId": 0, "PaymentTermDays": "string", "CreditCardType": "string", "CreditCardName": "string", "Phone": "string", "InvoiceFileFormat": "string", "AchMandateStatus": "string", "Address2": "string", "CurrencyCode": 0, "StatementApprovalFlag": 0, "StatementTemplateId": "string", "StatementDeliveryMethod": "string", "PeriodCutoffDate": "string", "AchBranchCode": "string", "AchScheme": "string", "NationalIdentityNumber": "string", "Email": "string", "CreditCardCCV": "string", "AchBankAcctName": "string", "StatementEarliestDate": "string", "BillTo": "string", "BillingCycle": "string", "PoNumber": "string", "Fax": "string", "TimeZoneId": "string", "AchMandateCountry": "string", "YearlyBillingMonth": "string", "CalendarClosingMonth": "string", "SemiAnnualBillingMonth": "string", "Attention": "string", "Address1": "string", "InvoiceApprovalFlag": 0, "WeeklyBillingDate": "string", "QuarterlyBillingMonth": "string", "MonthlyBillingDate": "string", "State": "string", "Zip": "string", "EventGroupType": "string", "AchBankAcctNum": "string", "AchBankName": "string", "CreditCardToken": "string", "AchUniqueRef": "string", "TaxEngineId": 0, "AchMandateReference": "string", "BillingMethod": "string", "CreditCardNumber": "string", "City": "string", "StatementCycle": "string", "ManualCloseFlag": 0, "EventBasedBilling": 0, "PaymentGatewayCustomerId": "string", "AchMandateState": "string", "HostedPaymentPageExternalId": "string", "Id": "string", "CalendarType": "string", "CalendarClosingWeekday": "string", "Status": "string", "InvGraceDaysBeforeClosing": "string", "Created": "string", "UpdatedUserId": "string", "Updated": "string", "CreatedUserId": "string", "BillingEntity": "string", "AchMandateEnabledFlag": 0, "AchMandateStatusModifyDate": "string", "CustomerRefNum": "string", "AccountId": "string", "AchEcheckType": "string" } }'
{ "retrieveResponse": { "CreditCardExpDate": "string", "Country": "string", "InvoiceDeliveryMethod": "string", "DunningInterval": "string", "AllowPricingInOtherCurrency": 0, "AchBankAbaCode": "string", "AchBankAcctType": "string", "DisablePDFGenerationOnInvoiceClose": 0, "InvoiceTemplateId": 0, "PaymentTermDays": "string", "CreditCardType": "string", "CreditCardName": "string", "Phone": "string", "InvoiceFileFormat": "string", "AchMandateStatus": "string", "Address2": "string", "CurrencyCode": 0, "StatementApprovalFlag": 0, "StatementTemplateId": "string", "StatementDeliveryMethod": "string", "PeriodCutoffDate": "string", "AchBranchCode": "string", "AchScheme": "string", "NationalIdentityNumber": "string", "Email": "string", "CreditCardCCV": "string", "AchBankAcctName": "string", "StatementEarliestDate": "string", "BillTo": "string", "BillingCycle": "string", "PoNumber": "string", "Fax": "string", "TimeZoneId": "string", "AchMandateCountry": "string", "YearlyBillingMonth": "string", "CalendarClosingMonth": "string", "SemiAnnualBillingMonth": "string", "Attention": "string", "Address1": "string", "InvoiceApprovalFlag": 0, "WeeklyBillingDate": "string", "QuarterlyBillingMonth": "string", "MonthlyBillingDate": "string", "State": "string", "Zip": "string", "EventGroupType": "string", "AchBankAcctNum": "string", "AchBankName": "string", "CreditCardToken": "string", "AchUniqueRef": "string", "TaxEngineId": 0, "AchMandateReference": "string", "BillingMethod": "string", "CreditCardNumber": "string", "City": "string", "StatementCycle": "string", "ManualCloseFlag": 0, "EventBasedBilling": 0, "PaymentGatewayCustomerId": "string", "AchMandateState": "string", "HostedPaymentPageExternalId": "string", "Id": "string", "CalendarType": "string", "CalendarClosingWeekday": "string", "Status": "string", "InvGraceDaysBeforeClosing": "string", "Created": "string", "UpdatedUserId": "string", "Updated": "string", "CreatedUserId": "string", "BillingEntity": "string", "AchMandateEnabledFlag": 0, "AchMandateStatusModifyDate": "string", "CustomerRefNum": "string", "AccountId": "string", "AchEcheckType": "string" } }
curl -i -X PUT \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/BILLING_PROFILE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "CreditCardExpDate": "string", "Country": "string", "InvoiceDeliveryMethod": "string", "DunningInterval": "string", "AllowPricingInOtherCurrency": 0, "AchBankAbaCode": "string", "AchBankAcctType": "string", "DisablePDFGenerationOnInvoiceClose": 0, "InvoiceTemplateId": 0, "PaymentTermDays": "string", "CreditCardType": "string", "CreditCardName": "string", "Phone": "string", "InvoiceFileFormat": "string", "AchMandateStatus": "string", "Address2": "string", "CurrencyCode": 0, "StatementApprovalFlag": 0, "StatementTemplateId": "string", "StatementDeliveryMethod": "string", "PeriodCutoffDate": "string", "AchBranchCode": "string", "AchScheme": "string", "NationalIdentityNumber": "string", "Email": "string", "CreditCardCCV": "string", "AchBankAcctName": "string", "StatementEarliestDate": "string", "BillTo": "string", "BillingCycle": "string", "PoNumber": "string", "Fax": "string", "TimeZoneId": "string", "AchMandateCountry": "string", "YearlyBillingMonth": "string", "CalendarClosingMonth": "string", "SemiAnnualBillingMonth": "string", "Attention": "string", "Address1": "string", "InvoiceApprovalFlag": 0, "WeeklyBillingDate": "string", "QuarterlyBillingMonth": "string", "MonthlyBillingDate": "string", "State": "string", "Zip": "string", "EventGroupType": "string", "AchBankAcctNum": "string", "AchBankName": "string", "CreditCardToken": "string", "AchUniqueRef": "string", "TaxEngineId": 0, "AchMandateReference": "string", "BillingMethod": "string", "CreditCardNumber": "string", "City": "string", "StatementCycle": "string", "ManualCloseFlag": 0, "EventBasedBilling": 0, "PaymentGatewayCustomerId": "string", "AchMandateState": "string", "HostedPaymentPageExternalId": "string", "Id": "string", "CalendarType": "string", "CalendarClosingWeekday": "string", "Status": "string", "InvGraceDaysBeforeClosing": "string", "Created": "string", "UpdatedUserId": "string", "Updated": "string", "CreatedUserId": "string", "BillingEntity": "string", "AchMandateEnabledFlag": 0, "AchMandateStatusModifyDate": "string", "CustomerRefNum": "string", "AccountId": "string", "AchEcheckType": "string" } }'
{ "retrieveResponse": { "CreditCardExpDate": "string", "Country": "string", "InvoiceDeliveryMethod": "string", "DunningInterval": "string", "AllowPricingInOtherCurrency": 0, "AchBankAbaCode": "string", "AchBankAcctType": "string", "DisablePDFGenerationOnInvoiceClose": 0, "InvoiceTemplateId": 0, "PaymentTermDays": "string", "CreditCardType": "string", "CreditCardName": "string", "Phone": "string", "InvoiceFileFormat": "string", "AchMandateStatus": "string", "Address2": "string", "CurrencyCode": 0, "StatementApprovalFlag": 0, "StatementTemplateId": "string", "StatementDeliveryMethod": "string", "PeriodCutoffDate": "string", "AchBranchCode": "string", "AchScheme": "string", "NationalIdentityNumber": "string", "Email": "string", "CreditCardCCV": "string", "AchBankAcctName": "string", "StatementEarliestDate": "string", "BillTo": "string", "BillingCycle": "string", "PoNumber": "string", "Fax": "string", "TimeZoneId": "string", "AchMandateCountry": "string", "YearlyBillingMonth": "string", "CalendarClosingMonth": "string", "SemiAnnualBillingMonth": "string", "Attention": "string", "Address1": "string", "InvoiceApprovalFlag": 0, "WeeklyBillingDate": "string", "QuarterlyBillingMonth": "string", "MonthlyBillingDate": "string", "State": "string", "Zip": "string", "EventGroupType": "string", "AchBankAcctNum": "string", "AchBankName": "string", "CreditCardToken": "string", "AchUniqueRef": "string", "TaxEngineId": 0, "AchMandateReference": "string", "BillingMethod": "string", "CreditCardNumber": "string", "City": "string", "StatementCycle": "string", "ManualCloseFlag": 0, "EventBasedBilling": 0, "PaymentGatewayCustomerId": "string", "AchMandateState": "string", "HostedPaymentPageExternalId": "string", "Id": "string", "CalendarType": "string", "CalendarClosingWeekday": "string", "Status": "string", "InvGraceDaysBeforeClosing": "string", "Created": "string", "UpdatedUserId": "string", "Updated": "string", "CreatedUserId": "string", "BillingEntity": "string", "AchMandateEnabledFlag": 0, "AchMandateStatusModifyDate": "string", "CustomerRefNum": "string", "AccountId": "string", "AchEcheckType": "string" } }
curl -i -X PATCH \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/BILLING_PROFILE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "CreditCardExpDate": "string", "Country": "string", "InvoiceDeliveryMethod": "string", "DunningInterval": "string", "AllowPricingInOtherCurrency": 0, "AchBankAbaCode": "string", "AchBankAcctType": "string", "DisablePDFGenerationOnInvoiceClose": 0, "InvoiceTemplateId": 0, "PaymentTermDays": "string", "CreditCardType": "string", "CreditCardName": "string", "Phone": "string", "InvoiceFileFormat": "string", "AchMandateStatus": "string", "Address2": "string", "CurrencyCode": 0, "StatementApprovalFlag": 0, "StatementTemplateId": "string", "StatementDeliveryMethod": "string", "PeriodCutoffDate": "string", "AchBranchCode": "string", "AchScheme": "string", "NationalIdentityNumber": "string", "Email": "string", "CreditCardCCV": "string", "AchBankAcctName": "string", "StatementEarliestDate": "string", "BillTo": "string", "BillingCycle": "string", "PoNumber": "string", "Fax": "string", "TimeZoneId": "string", "AchMandateCountry": "string", "YearlyBillingMonth": "string", "CalendarClosingMonth": "string", "SemiAnnualBillingMonth": "string", "Attention": "string", "Address1": "string", "InvoiceApprovalFlag": 0, "WeeklyBillingDate": "string", "QuarterlyBillingMonth": "string", "MonthlyBillingDate": "string", "State": "string", "Zip": "string", "EventGroupType": "string", "AchBankAcctNum": "string", "AchBankName": "string", "CreditCardToken": "string", "AchUniqueRef": "string", "TaxEngineId": 0, "AchMandateReference": "string", "BillingMethod": "string", "CreditCardNumber": "string", "City": "string", "StatementCycle": "string", "ManualCloseFlag": 0, "EventBasedBilling": 0, "PaymentGatewayCustomerId": "string", "AchMandateState": "string", "HostedPaymentPageExternalId": "string", "Id": "string", "CalendarType": "string", "CalendarClosingWeekday": "string", "Status": "string", "InvGraceDaysBeforeClosing": "string", "Created": "string", "UpdatedUserId": "string", "Updated": "string", "CreatedUserId": "string", "BillingEntity": "string", "AchMandateEnabledFlag": 0, "AchMandateStatusModifyDate": "string", "CustomerRefNum": "string", "AccountId": "string", "AchEcheckType": "string" }, "externalIDFieldName": "PaymentGatewayCustomerId" }'
{ "upsertResponse": [ { … } ] }
curl -i -X DELETE \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/delete/BILLING_PROFILE \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "Id": "string" } }'
{ "retrieveResponse": { "CreditCardExpDate": "string", "Country": "string", "InvoiceDeliveryMethod": "string", "DunningInterval": "string", "AllowPricingInOtherCurrency": 0, "AchBankAbaCode": "string", "AchBankAcctType": "string", "DisablePDFGenerationOnInvoiceClose": 0, "InvoiceTemplateId": 0, "PaymentTermDays": "string", "CreditCardType": "string", "CreditCardName": "string", "Phone": "string", "InvoiceFileFormat": "string", "AchMandateStatus": "string", "Address2": "string", "CurrencyCode": 0, "StatementApprovalFlag": 0, "StatementTemplateId": "string", "StatementDeliveryMethod": "string", "PeriodCutoffDate": "string", "AchBranchCode": "string", "AchScheme": "string", "NationalIdentityNumber": "string", "Email": "string", "CreditCardCCV": "string", "AchBankAcctName": "string", "StatementEarliestDate": "string", "BillTo": "string", "BillingCycle": "string", "PoNumber": "string", "Fax": "string", "TimeZoneId": "string", "AchMandateCountry": "string", "YearlyBillingMonth": "string", "CalendarClosingMonth": "string", "SemiAnnualBillingMonth": "string", "Attention": "string", "Address1": "string", "InvoiceApprovalFlag": 0, "WeeklyBillingDate": "string", "QuarterlyBillingMonth": "string", "MonthlyBillingDate": "string", "State": "string", "Zip": "string", "EventGroupType": "string", "AchBankAcctNum": "string", "AchBankName": "string", "CreditCardToken": "string", "AchUniqueRef": "string", "TaxEngineId": 0, "AchMandateReference": "string", "BillingMethod": "string", "CreditCardNumber": "string", "City": "string", "StatementCycle": "string", "ManualCloseFlag": 0, "EventBasedBilling": 0, "PaymentGatewayCustomerId": "string", "AchMandateState": "string", "HostedPaymentPageExternalId": "string", "Id": "string", "CalendarType": "string", "CalendarClosingWeekday": "string", "Status": "string", "InvGraceDaysBeforeClosing": "string", "Created": "string", "UpdatedUserId": "string", "Updated": "string", "CreatedUserId": "string", "BillingEntity": "string", "AchMandateEnabledFlag": 0, "AchMandateStatusModifyDate": "string", "CustomerRefNum": "string", "AccountId": "string", "AchEcheckType": "string" } }