openapi: 3.0.1 info: title: Billing REST API description: Billing REST API services guide. Other Billing guides available <a href='https://documentation.conga.com'>here</a>. version: v1 servers: - url: https://salesforce.com/services/apexrest/Apttus_Billing tags: - name: Invoice Creation - name: Usage Input Processing paths: /CreateInvoices/v1/createInvoices: post: tags: - Invoice Creation summary: Create invoices for the given list of account IDs. description: Create invoices for given Account IDs. It accepts a list of Account IDs, invoiceDate, and targetDateTime as input parameters. It creates invoices for billing schedules that have status as pending billing, and ReadyForInvoiceDate less than the targetDate. All the new invoices are created with Invoice Date as the value mentioned in invoiceDate. operationId: createInvoices parameters: - name: grant_type in: query description: Put value as _password_ required: true schema: type: string - name: client_id in: query required: true schema: type: string - name: client_secret in: query required: true schema: type: string - name: username in: query required: true schema: type: string - name: password in: query description: Password + Security token required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateInvoices_Input' required: true responses: 200: description: OK content: {} x-codegen-request-body-name: body /CreateInvoicesForOrder/v1/createInvoicesForOrder: post: tags: - Invoice Creation summary: Creates invoices for the given order ID. description: Create invoices for the given order ID. It accepts an order ID, targetDate and invoiceDate as input parameters. It creates invoices for billing scheules that have status as pending and ReadyForInvoiceDate less than the targetDate. All the new invoices are created with Invoice Date as the value mentioned in invoiceDate. operationId: createInvoicesForOrder parameters: - name: grant_type in: query description: Put value as _password_ required: true schema: type: string - name: client_id in: query required: true schema: type: string - name: client_secret in: query required: true schema: type: string - name: username in: query required: true schema: type: string - name: password in: query description: Password + Security token required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateInvoicesForOrder_Input' required: true responses: 200: description: OK content: application/json: schema: $ref: '#/components/schemas/CreateInvoicesForOrder_Output' x-codegen-request-body-name: body /ProcessUsageInput/v1/processPendingUsageInput: post: tags: - Usage Input Processing summary: Processes all the pending usage inputs across the entire organization. description: Processes all the usage inputs with status as 'Loaded'. On completion of the batch job, the user receives a batch job status email. operationId: processPendingUsageInput parameters: - name: grant_type in: query description: Put value as _password_ required: true schema: type: string - name: client_id in: query required: true schema: type: string - name: client_secret in: query required: true schema: type: string - name: username in: query required: true schema: type: string - name: password in: query description: Password + Security token required: true schema: type: string responses: 200: description: OK content: {} components: schemas: CreateInvoices_Input: required: - billToAccountIds - invoiceDate - targetDate type: object properties: billToAccountIds: type: array description: Bill-to account IDs items: type: string example: "" targetDate: type: string description: Date string of the format 'yyyy-mm-dd' example: 2018-03-15 invoiceDate: type: string description: Date string of the format 'yyyy-mm-dd' example: 2018-12-31 CreateInvoicesForOrder_Input: required: - invoiceDate - orderId - targetDate type: object properties: orderId: type: string example: a3S5x000001OEgw targetDate: type: string description: Date string of the format 'yyyy-mm-dd' example: 2018-03-15 invoiceDate: type: string description: Date string of the format 'yyyy-mm-dd' example: 2018-12-31 CreateInvoicesForOrder_Output: type: object properties: attributes: type: object properties: type: type: string example: Apttus_Billing__Invoice__c url: type: string example: /services/data/v31.0/sobjects/Apttus_Billing__Invoice__c/a5zW00000005EytIAE Id: type: string example: a5zW00000005EytIAE Name: type: string example: INV-00000012 Apttus_Billing__Type__c: type: string example: Standard Apttus_Billing__TotalInvoiceAmount__c: type: integer Apttus_Billing__ShipToAccountId__c: type: string example: 001W000000LSAJHIA5 Apttus_Billing__InvoiceDate__c: type: string example: 2018-03-03T12:39:23.000+0000 Apttus_Billing__DueDate__c: type: string example: 2018-03-03T12:39:23.000+0000 Apttus_Billing__BillToAccountId__c: type: string example: 001W000000LSAJHIA5